# Create FHIR r4 task
Endpoint: POST /site/{siteId}/fhir/task
Version: 1.0
Security: bearer, bearer
## Path parameters:
- `siteId` (string, required)
Site identifier
## Request fields (application/json):
- `resourceType` (any, required)
This is a Task resource
Enum: "Task"
- `id` (string)
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
- `meta` (object)
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- `meta.id` (string)
An extension object type #string.
Example: "example-string"
- `meta.extension` (array)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- `meta.versionId` (object)
An extension object type #id.
- `meta._versionId` (object)
An extension object type #Element.
- `meta.lastUpdated` (object)
An extension object type #instant.
- `meta._lastUpdated` (object)
An extension object type #Element.
- `meta.source` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `meta._source` (object)
An extension object type #Element.
- `meta.profile` (array)
A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
Example: ["http://example.org/Profile"]
- `meta.security` (array)
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
- `meta.tag` (array)
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
- `implicitRules` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_implicitRules` (object)
Base definition for all elements in a resource.
- `language` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_language` (object)
Base definition for all elements in a resource.
- `text` (object)
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
- `text.status` (any)
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
Enum: "generated", "extensions", "additional", "empty"
- `text._status` (object)
An extension object type #Element.
- `text.div` (string, required)
An extension object type #xhtml.
Example: "
Example
"
- `contained` (array)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- `extension` (array)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Example: [{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-category","valueString":"Base.Workflow"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":2},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"not-classified"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"oo"}]
- `extension.url` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `extension._url` (object)
An extension object type #Element.
- `extension.valueBase64Binary` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "U2FtcGxl"
- `extension._valueBase64Binary` (object)
An extension object type #Element.
- `extension.valueBoolean` (boolean)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: true
- `extension._valueBoolean` (object)
An extension object type #Element.
- `extension.valueCanonical` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "http://example.org/Profile"
- `extension._valueCanonical` (object)
An extension object type #Element.
- `extension.valueCode` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "sample-code"
- `extension._valueCode` (object)
An extension object type #Element.
- `extension.valueDate` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01"
- `extension._valueDate` (object)
An extension object type #Element.
- `extension.valueDateTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueDateTime` (object)
An extension object type #Element.
- `extension.valueDecimal` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1.23
- `extension._valueDecimal` (object)
An extension object type #Element.
- `extension.valueId` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-id"
- `extension._valueId` (object)
An extension object type #Element.
- `extension.valueInstant` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueInstant` (object)
An extension object type #Element.
- `extension.valueInteger` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valueInteger` (object)
An extension object type #Element.
- `extension.valueMarkdown` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "Sample markdown text"
- `extension._valueMarkdown` (object)
An extension object type #Element.
- `extension.valueOid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:oid:1.2.3.4.5"
- `extension._valueOid` (object)
An extension object type #Element.
- `extension.valuePositiveInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valuePositiveInt` (object)
An extension object type #Element.
- `extension.valueString` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-string"
- `extension._valueString` (object)
An extension object type #Element.
- `extension.valueTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "12:00:00"
- `extension._valueTime` (object)
An extension object type #Element.
- `extension.valueUnsignedInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
- `extension._valueUnsignedInt` (object)
An extension object type #Element.
- `extension.valueUri` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org/resource"
- `extension._valueUri` (object)
An extension object type #Element.
- `extension.valueUrl` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org"
- `extension._valueUrl` (object)
An extension object type #Element.
- `extension.valueUuid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
- `extension._valueUuid` (object)
An extension object type #Element.
- `extension.valueAddress` (object)
An extension object type #Address.
- `extension.valueAge` (object)
An extension object type #Age.
- `extension.valueAnnotation` (object)
An extension object type #Annotation.
- `extension.valueAttachment` (object)
An extension object type #Attachment.
- `extension.valueCodeableConcept` (object)
An extension object type #CodeableConcept.
- `extension.valueCoding` (object)
An extension object type #Coding.
- `extension.valueContactPoint` (object)
An extension object type #ContactPoint.
- `extension.valueCount` (object)
An extension object type #Count.
- `extension.valueDistance` (object)
An extension object type #Distance.
- `extension.valueDuration` (object)
An extension object type #Duration.
- `extension.valueHumanName` (object)
An extension object type #HumanName.
- `extension.valueIdentifier` (object)
An extension object type #Identifier.
- `extension.valueMoney` (object)
An extension object type #Money.
- `extension.valuePeriod` (object)
An extension object type #Period.
- `extension.valueQuantity` (object)
An extension object type #Quantity.
- `extension.valueRange` (object)
An extension object type #Range.
- `extension.valueRatio` (object)
An extension object type #Ratio.
- `extension.valueReference` (object)
An extension object type #Reference.
- `extension.valueSampledData` (object)
An extension object type #SampledData.
- `extension.valueSignature` (object)
An extension object type #Signature.
- `extension.valueTiming` (object)
An extension object type #Timing.
- `extension.valueContactDetail` (object)
An extension object type #ContactDetail.
- `extension.valueContributor` (object)
An extension object type #Contributor.
- `extension.valueDataRequirement` (object)
An extension object type #DataRequirement.
- `extension.valueExpression` (object)
An extension object type #Expression.
- `extension.valueParameterDefinition` (object)
An extension object type #ParameterDefinition.
- `extension.valueRelatedArtifact` (object)
An extension object type #RelatedArtifact.
- `extension.valueTriggerDefinition` (object)
An extension object type #TriggerDefinition.
- `extension.valueUsageContext` (object)
An extension object type #UsageContext.
- `extension.valueDosage` (object)
An extension object type #Dosage.
- `extension.valueMeta` (object)
An extension object type #Meta.
- `modifierExtension` (array)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- `identifier` (array)
The business identifier for this task.
- `identifier.use` (any)
The purpose of this identifier.
Enum: "usual", "official", "temp", "secondary", "old"
- `identifier._use` (object)
An extension object type #Element.
- `identifier.type` (object)
An extension object type #CodeableConcept.
- `identifier.system` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `identifier._system` (object)
An extension object type #Element.
- `identifier.value` (string)
An extension object type #string.
Example: "example-string"
- `identifier._value` (object)
An extension object type #Element.
- `identifier.period` (object)
An extension object type #Period.
- `identifier.assigner` (object)
An extension object type #Reference.
- `instantiatesCanonical` (string)
A URI that is a reference to a canonical URL on a FHIR resource
Example: "http://example.org/Profile"
- `instantiatesUri` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_instantiatesUri` (object)
Base definition for all elements in a resource.
- `basedOn` (array)
BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
- `basedOn.reference` (string)
An extension object type #string.
Example: "example-string"
- `basedOn._reference` (object)
An extension object type #Element.
- `basedOn.type` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `basedOn._type` (object)
An extension object type #Element.
- `basedOn.identifier` (object)
An extension object type #Identifier.
- `basedOn.display` (string)
An extension object type #string.
Example: "example-string"
- `basedOn._display` (object)
An extension object type #Element.
- `groupIdentifier` (object)
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
- `partOf` (array)
Task that this particular task is part of.
- `status` (any)
The current status of the task.
Enum: "draft", "requested", "received", "accepted", "rejected", "ready", "cancelled", "in-progress", "on-hold", "failed", "completed", "entered-in-error"
- `_status` (object)
Base definition for all elements in a resource.
- `statusReason` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `statusReason.coding` (array)
A reference to a code defined by a terminology system.
- `statusReason.text` (string)
An extension object type #string.
Example: "example-string"
- `statusReason._text` (object)
An extension object type #Element.
- `businessStatus` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `intent` (any)
Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
Enum: "unknown", "proposal", "plan", "order", "original-order", "reflex-order", "filler-order", "instance-order", "option"
- `_intent` (object)
Base definition for all elements in a resource.
- `priority` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_priority` (object)
Base definition for all elements in a resource.
- `code` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `description` (string)
A sequence of Unicode characters
Example: "example-string"
- `_description` (object)
Base definition for all elements in a resource.
- `focus` (object)
A reference from one resource to another.
- `for` (object)
A reference from one resource to another.
- `encounter` (object)
A reference from one resource to another.
- `executionPeriod` (object)
A time period defined by a start and end date and optionally time.
- `executionPeriod.start` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `executionPeriod._start` (object)
An extension object type #Element.
- `executionPeriod.end` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `executionPeriod._end` (object)
An extension object type #Element.
- `authoredOn` (string)
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
- `_authoredOn` (object)
Base definition for all elements in a resource.
- `lastModified` (string)
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
- `_lastModified` (object)
Base definition for all elements in a resource.
- `requester` (object)
A reference from one resource to another.
- `performerType` (array)
The kind of participant that should perform the task.
- `owner` (object)
A reference from one resource to another.
- `location` (object)
A reference from one resource to another.
- `reasonCode` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `reasonReference` (object)
A reference from one resource to another.
- `insurance` (array)
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
- `note` (array)
Free-text information captured about the task as it progresses.
- `note.authorReference` (object)
An extension object type #Reference.
- `note.authorString` (string)
The individual responsible for making the annotation.
Example: "example-string"
- `note._authorString` (object)
An extension object type #Element.
- `note.time` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `note._time` (object)
An extension object type #Element.
- `note.text` (object)
An extension object type #markdown.
- `relevantHistory` (array)
Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
- `restriction` (object)
A task to be performed.
- `restriction.modifierExtension` (array)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- `restriction.repetitions` (integer)
An extension object type #positiveInt.
Example: 1
- `restriction._repetitions` (object)
An extension object type #Element.
- `restriction.recipient` (array)
For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?
- `input` (array)
Additional information that may be needed in the execution of the task.
- `input.valueBase64Binary` (string)
The value of the input parameter as a basic type.
Example: "U2FtcGxl"
- `input.valueBoolean` (boolean)
The value of the input parameter as a basic type.
Example: true
- `input.valueCanonical` (string)
The value of the input parameter as a basic type.
Example: "http://example.org/Profile"
- `input.valueCode` (string)
The value of the input parameter as a basic type.
Example: "sample-code"
- `input.valueDate` (string)
The value of the input parameter as a basic type.
Example: "2024-01-01"
- `input.valueDateTime` (string)
The value of the input parameter as a basic type.
Example: "2024-01-01T00:00:00Z"
- `input.valueDecimal` (number)
The value of the input parameter as a basic type.
Example: 1.23
- `input.valueId` (string)
The value of the input parameter as a basic type.
Example: "example-id"
- `input.valueInstant` (string)
The value of the input parameter as a basic type.
Example: "2024-01-01T00:00:00Z"
- `input.valueInteger` (number)
The value of the input parameter as a basic type.
Example: 1
- `input.valueMarkdown` (string)
The value of the input parameter as a basic type.
Example: "Sample markdown text"
- `input.valueOid` (string)
The value of the input parameter as a basic type.
Example: "urn:oid:1.2.3.4.5"
- `input.valuePositiveInt` (number)
The value of the input parameter as a basic type.
Example: 1
- `input.valueString` (string)
The value of the input parameter as a basic type.
Example: "example-string"
- `input.valueTime` (string)
The value of the input parameter as a basic type.
Example: "12:00:00"
- `input.valueUnsignedInt` (number)
The value of the input parameter as a basic type.
- `input.valueUri` (string)
The value of the input parameter as a basic type.
Example: "https://example.org/resource"
- `input.valueUrl` (string)
The value of the input parameter as a basic type.
Example: "https://example.org"
- `input.valueUuid` (string)
The value of the input parameter as a basic type.
Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
- `output` (array)
Outputs produced by the Task.
- `output.valueBase64Binary` (string)
The value of the Output parameter as a basic type.
Example: "U2FtcGxl"
- `output.valueBoolean` (boolean)
The value of the Output parameter as a basic type.
Example: true
- `output.valueCanonical` (string)
The value of the Output parameter as a basic type.
Example: "http://example.org/Profile"
- `output.valueCode` (string)
The value of the Output parameter as a basic type.
Example: "sample-code"
- `output.valueDate` (string)
The value of the Output parameter as a basic type.
Example: "2024-01-01"
- `output.valueDateTime` (string)
The value of the Output parameter as a basic type.
Example: "2024-01-01T00:00:00Z"
- `output.valueDecimal` (number)
The value of the Output parameter as a basic type.
Example: 1.23
- `output.valueId` (string)
The value of the Output parameter as a basic type.
Example: "example-id"
- `output.valueInstant` (string)
The value of the Output parameter as a basic type.
Example: "2024-01-01T00:00:00Z"
- `output.valueInteger` (number)
The value of the Output parameter as a basic type.
Example: 1
- `output.valueMarkdown` (string)
The value of the Output parameter as a basic type.
Example: "Sample markdown text"
- `output.valueOid` (string)
The value of the Output parameter as a basic type.
Example: "urn:oid:1.2.3.4.5"
- `output.valuePositiveInt` (number)
The value of the Output parameter as a basic type.
Example: 1
- `output.valueString` (string)
The value of the Output parameter as a basic type.
Example: "example-string"
- `output.valueTime` (string)
The value of the Output parameter as a basic type.
Example: "12:00:00"
- `output.valueUnsignedInt` (number)
The value of the Output parameter as a basic type.
- `output.valueUri` (string)
The value of the Output parameter as a basic type.
Example: "https://example.org/resource"
- `output.valueUrl` (string)
The value of the Output parameter as a basic type.
Example: "https://example.org"
- `output.valueUuid` (string)
The value of the Output parameter as a basic type.
Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
## Response 200 fields (application/json):
- `resourceType` (any, required)
This is a Task resource
Enum: "Task"
- `id` (string)
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
- `meta` (object)
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- `meta.id` (string)
An extension object type #string.
Example: "example-string"
- `meta.extension` (array)
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- `meta.versionId` (object)
An extension object type #id.
- `meta._versionId` (object)
An extension object type #Element.
- `meta.lastUpdated` (object)
An extension object type #instant.
- `meta._lastUpdated` (object)
An extension object type #Element.
- `meta.source` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `meta._source` (object)
An extension object type #Element.
- `meta.profile` (array)
A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
Example: ["http://example.org/Profile"]
- `meta.security` (array)
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
- `meta.tag` (array)
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
- `implicitRules` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_implicitRules` (object)
Base definition for all elements in a resource.
- `language` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_language` (object)
Base definition for all elements in a resource.
- `text` (object)
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
- `text.status` (any)
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
Enum: "generated", "extensions", "additional", "empty"
- `text._status` (object)
An extension object type #Element.
- `text.div` (string, required)
An extension object type #xhtml.
Example: "Example
"
- `contained` (array)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- `extension` (array)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Example: [{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-category","valueString":"Base.Workflow"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":2},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"not-classified"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"oo"}]
- `extension.url` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `extension._url` (object)
An extension object type #Element.
- `extension.valueBase64Binary` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "U2FtcGxl"
- `extension._valueBase64Binary` (object)
An extension object type #Element.
- `extension.valueBoolean` (boolean)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: true
- `extension._valueBoolean` (object)
An extension object type #Element.
- `extension.valueCanonical` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "http://example.org/Profile"
- `extension._valueCanonical` (object)
An extension object type #Element.
- `extension.valueCode` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "sample-code"
- `extension._valueCode` (object)
An extension object type #Element.
- `extension.valueDate` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01"
- `extension._valueDate` (object)
An extension object type #Element.
- `extension.valueDateTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueDateTime` (object)
An extension object type #Element.
- `extension.valueDecimal` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1.23
- `extension._valueDecimal` (object)
An extension object type #Element.
- `extension.valueId` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-id"
- `extension._valueId` (object)
An extension object type #Element.
- `extension.valueInstant` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueInstant` (object)
An extension object type #Element.
- `extension.valueInteger` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valueInteger` (object)
An extension object type #Element.
- `extension.valueMarkdown` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "Sample markdown text"
- `extension._valueMarkdown` (object)
An extension object type #Element.
- `extension.valueOid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:oid:1.2.3.4.5"
- `extension._valueOid` (object)
An extension object type #Element.
- `extension.valuePositiveInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valuePositiveInt` (object)
An extension object type #Element.
- `extension.valueString` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-string"
- `extension._valueString` (object)
An extension object type #Element.
- `extension.valueTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "12:00:00"
- `extension._valueTime` (object)
An extension object type #Element.
- `extension.valueUnsignedInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
- `extension._valueUnsignedInt` (object)
An extension object type #Element.
- `extension.valueUri` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org/resource"
- `extension._valueUri` (object)
An extension object type #Element.
- `extension.valueUrl` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org"
- `extension._valueUrl` (object)
An extension object type #Element.
- `extension.valueUuid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
- `extension._valueUuid` (object)
An extension object type #Element.
- `extension.valueAddress` (object)
An extension object type #Address.
- `extension.valueAge` (object)
An extension object type #Age.
- `extension.valueAnnotation` (object)
An extension object type #Annotation.
- `extension.valueAttachment` (object)
An extension object type #Attachment.
- `extension.valueCodeableConcept` (object)
An extension object type #CodeableConcept.
- `extension.valueCoding` (object)
An extension object type #Coding.
- `extension.valueContactPoint` (object)
An extension object type #ContactPoint.
- `extension.valueCount` (object)
An extension object type #Count.
- `extension.valueDistance` (object)
An extension object type #Distance.
- `extension.valueDuration` (object)
An extension object type #Duration.
- `extension.valueHumanName` (object)
An extension object type #HumanName.
- `extension.valueIdentifier` (object)
An extension object type #Identifier.
- `extension.valueMoney` (object)
An extension object type #Money.
- `extension.valuePeriod` (object)
An extension object type #Period.
- `extension.valueQuantity` (object)
An extension object type #Quantity.
- `extension.valueRange` (object)
An extension object type #Range.
- `extension.valueRatio` (object)
An extension object type #Ratio.
- `extension.valueReference` (object)
An extension object type #Reference.
- `extension.valueSampledData` (object)
An extension object type #SampledData.
- `extension.valueSignature` (object)
An extension object type #Signature.
- `extension.valueTiming` (object)
An extension object type #Timing.
- `extension.valueContactDetail` (object)
An extension object type #ContactDetail.
- `extension.valueContributor` (object)
An extension object type #Contributor.
- `extension.valueDataRequirement` (object)
An extension object type #DataRequirement.
- `extension.valueExpression` (object)
An extension object type #Expression.
- `extension.valueParameterDefinition` (object)
An extension object type #ParameterDefinition.
- `extension.valueRelatedArtifact` (object)
An extension object type #RelatedArtifact.
- `extension.valueTriggerDefinition` (object)
An extension object type #TriggerDefinition.
- `extension.valueUsageContext` (object)
An extension object type #UsageContext.
- `extension.valueDosage` (object)
An extension object type #Dosage.
- `extension.valueMeta` (object)
An extension object type #Meta.
- `modifierExtension` (array)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- `identifier` (array)
The business identifier for this task.
- `identifier.use` (any)
The purpose of this identifier.
Enum: "usual", "official", "temp", "secondary", "old"
- `identifier._use` (object)
An extension object type #Element.
- `identifier.type` (object)
An extension object type #CodeableConcept.
- `identifier.system` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `identifier._system` (object)
An extension object type #Element.
- `identifier.value` (string)
An extension object type #string.
Example: "example-string"
- `identifier._value` (object)
An extension object type #Element.
- `identifier.period` (object)
An extension object type #Period.
- `identifier.assigner` (object)
An extension object type #Reference.
- `instantiatesCanonical` (string)
A URI that is a reference to a canonical URL on a FHIR resource
Example: "http://example.org/Profile"
- `instantiatesUri` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_instantiatesUri` (object)
Base definition for all elements in a resource.
- `basedOn` (array)
BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
- `basedOn.reference` (string)
An extension object type #string.
Example: "example-string"
- `basedOn._reference` (object)
An extension object type #Element.
- `basedOn.type` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `basedOn._type` (object)
An extension object type #Element.
- `basedOn.identifier` (object)
An extension object type #Identifier.
- `basedOn.display` (string)
An extension object type #string.
Example: "example-string"
- `basedOn._display` (object)
An extension object type #Element.
- `groupIdentifier` (object)
An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
- `partOf` (array)
Task that this particular task is part of.
- `status` (any)
The current status of the task.
Enum: "draft", "requested", "received", "accepted", "rejected", "ready", "cancelled", "in-progress", "on-hold", "failed", "completed", "entered-in-error"
- `_status` (object)
Base definition for all elements in a resource.
- `statusReason` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `statusReason.coding` (array)
A reference to a code defined by a terminology system.
- `statusReason.text` (string)
An extension object type #string.
Example: "example-string"
- `statusReason._text` (object)
An extension object type #Element.
- `businessStatus` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `intent` (any)
Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
Enum: "unknown", "proposal", "plan", "order", "original-order", "reflex-order", "filler-order", "instance-order", "option"
- `_intent` (object)
Base definition for all elements in a resource.
- `priority` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_priority` (object)
Base definition for all elements in a resource.
- `code` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `description` (string)
A sequence of Unicode characters
Example: "example-string"
- `_description` (object)
Base definition for all elements in a resource.
- `focus` (object)
A reference from one resource to another.
- `for` (object)
A reference from one resource to another.
- `encounter` (object)
A reference from one resource to another.
- `executionPeriod` (object)
A time period defined by a start and end date and optionally time.
- `executionPeriod.start` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `executionPeriod._start` (object)
An extension object type #Element.
- `executionPeriod.end` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `executionPeriod._end` (object)
An extension object type #Element.
- `authoredOn` (string)
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
- `_authoredOn` (object)
Base definition for all elements in a resource.
- `lastModified` (string)
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
- `_lastModified` (object)
Base definition for all elements in a resource.
- `requester` (object)
A reference from one resource to another.
- `performerType` (array)
The kind of participant that should perform the task.
- `owner` (object)
A reference from one resource to another.
- `location` (object)
A reference from one resource to another.
- `reasonCode` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `reasonReference` (object)
A reference from one resource to another.
- `insurance` (array)
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
- `note` (array)
Free-text information captured about the task as it progresses.
- `note.authorReference` (object)
An extension object type #Reference.
- `note.authorString` (string)
The individual responsible for making the annotation.
Example: "example-string"
- `note._authorString` (object)
An extension object type #Element.
- `note.time` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `note._time` (object)
An extension object type #Element.
- `note.text` (object)
An extension object type #markdown.
- `relevantHistory` (array)
Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
- `restriction` (object)
A task to be performed.
- `restriction.modifierExtension` (array)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- `restriction.repetitions` (integer)
An extension object type #positiveInt.
Example: 1
- `restriction._repetitions` (object)
An extension object type #Element.
- `restriction.recipient` (array)
For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?
- `input` (array)
Additional information that may be needed in the execution of the task.
- `input.valueBase64Binary` (string)
The value of the input parameter as a basic type.
Example: "U2FtcGxl"
- `input.valueBoolean` (boolean)
The value of the input parameter as a basic type.
Example: true
- `input.valueCanonical` (string)
The value of the input parameter as a basic type.
Example: "http://example.org/Profile"
- `input.valueCode` (string)
The value of the input parameter as a basic type.
Example: "sample-code"
- `input.valueDate` (string)
The value of the input parameter as a basic type.
Example: "2024-01-01"
- `input.valueDateTime` (string)
The value of the input parameter as a basic type.
Example: "2024-01-01T00:00:00Z"
- `input.valueDecimal` (number)
The value of the input parameter as a basic type.
Example: 1.23
- `input.valueId` (string)
The value of the input parameter as a basic type.
Example: "example-id"
- `input.valueInstant` (string)
The value of the input parameter as a basic type.
Example: "2024-01-01T00:00:00Z"
- `input.valueInteger` (number)
The value of the input parameter as a basic type.
Example: 1
- `input.valueMarkdown` (string)
The value of the input parameter as a basic type.
Example: "Sample markdown text"
- `input.valueOid` (string)
The value of the input parameter as a basic type.
Example: "urn:oid:1.2.3.4.5"
- `input.valuePositiveInt` (number)
The value of the input parameter as a basic type.
Example: 1
- `input.valueString` (string)
The value of the input parameter as a basic type.
Example: "example-string"
- `input.valueTime` (string)
The value of the input parameter as a basic type.
Example: "12:00:00"
- `input.valueUnsignedInt` (number)
The value of the input parameter as a basic type.
- `input.valueUri` (string)
The value of the input parameter as a basic type.
Example: "https://example.org/resource"
- `input.valueUrl` (string)
The value of the input parameter as a basic type.
Example: "https://example.org"
- `input.valueUuid` (string)
The value of the input parameter as a basic type.
Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
- `output` (array)
Outputs produced by the Task.
- `output.valueBase64Binary` (string)
The value of the Output parameter as a basic type.
Example: "U2FtcGxl"
- `output.valueBoolean` (boolean)
The value of the Output parameter as a basic type.
Example: true
- `output.valueCanonical` (string)
The value of the Output parameter as a basic type.
Example: "http://example.org/Profile"
- `output.valueCode` (string)
The value of the Output parameter as a basic type.
Example: "sample-code"
- `output.valueDate` (string)
The value of the Output parameter as a basic type.
Example: "2024-01-01"
- `output.valueDateTime` (string)
The value of the Output parameter as a basic type.
Example: "2024-01-01T00:00:00Z"
- `output.valueDecimal` (number)
The value of the Output parameter as a basic type.
Example: 1.23
- `output.valueId` (string)
The value of the Output parameter as a basic type.
Example: "example-id"
- `output.valueInstant` (string)
The value of the Output parameter as a basic type.
Example: "2024-01-01T00:00:00Z"
- `output.valueInteger` (number)
The value of the Output parameter as a basic type.
Example: 1
- `output.valueMarkdown` (string)
The value of the Output parameter as a basic type.
Example: "Sample markdown text"
- `output.valueOid` (string)
The value of the Output parameter as a basic type.
Example: "urn:oid:1.2.3.4.5"
- `output.valuePositiveInt` (number)
The value of the Output parameter as a basic type.
Example: 1
- `output.valueString` (string)
The value of the Output parameter as a basic type.
Example: "example-string"
- `output.valueTime` (string)
The value of the Output parameter as a basic type.
Example: "12:00:00"
- `output.valueUnsignedInt` (number)
The value of the Output parameter as a basic type.
- `output.valueUri` (string)
The value of the Output parameter as a basic type.
Example: "https://example.org/resource"
- `output.valueUrl` (string)
The value of the Output parameter as a basic type.
Example: "https://example.org"
- `output.valueUuid` (string)
The value of the Output parameter as a basic type.
Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
## Response 401 fields (application/json):
- `message` (string, required)
Error message indicating unauthorized access.
Example: "Unauthorized"
- `statusCode` (number, required)
HTTP status code for unauthorized access.
Example: 401
## Response 400 fields
## Response 404 fields