Specialty Medication Enrollment
2.1.0 - CI Build

Specialty Medication Enrollment, published by HL7 International - Pharmacy. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/fhir-specialty-rx/ and changes regularly. See the Directory of published versions

## Resource Profile: SpecialtyRxTaskSmartLaunch - Detailed Descriptions

Active as of 2021-03-02

Definitions for the specialty-rx-task-smart-launch resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here.

1. Task
2. Task.id
Control | 10..1
Must Support | true
3. Task.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..*
Must Support | true
Comments | MAY contain multiple task identifiers, but one SHALL be an application context ID to be passed in the appContext parameter while launching the SMART app specified in this Task.
Slicing | This element introduces a set of slices on Task.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ $this
4. Task.identifier:appContext
SliceName | appContext
Definition | A unique identifier representing the context of this task within the SMART application (e.g., the specific set of questions that need to be answered). It is conveyed during launch of the referenced SMART application in the appContext parameter and used by that application to direct the user to information and functions necessary to complete this task.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Must Support | true
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <type> <coding> <system value="http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic"/> <code value="app-context"/> </coding> </type> </valueIdentifier>
5. Task.identifier:appContext.type
Control | 1..?
Must Support | true
Comments | At least one identifier SHALL be a SMART application contenxt identifier
6. Task.identifier:appContext.system
Control | 1..?
Type | uri
Must Support | true
7. Task.identifier:appContext.value
Control | 1..?
Type | string
Must Support | true
8. Task.intent
Must Support | true
Fixed Value | plan
9. Task.code
Definition | The SMART app task type: complete-app-questionnaire A name or code (or both) briefly describing what the task involves.
Control | 10..1
Binding | The codes SHALL be taken from Specialty Rx Value Set - Task Type For example codes, see TaskCode Task types used in the Specialty Rx workflow Codes to identify what the task involves. These will typically be specific to a particular workflow.
Must Support | true
Comments | Code specifying the requested user action to be performed using the referenced SMART app: complete-app-questionnaire The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic"/> <code value="complete-app-questionnaire"/> <display value="Complete Questionnaire in SMART App"/> </coding> </valueCodeableConcept>
10. Task.description
Definition | Human-readable description of the task to be performed by the user. A free-text description of what is to be performed.
Control | 10..1
Must Support | true
Comments | SHOULD include the user-recognizable name of the SMART application to launch to perform the task. SHALL state the action to be performed in the app once it's been launched.
11. Task.for
Definition | The patient for whom the related prescription was written, as represented in the Data Source system The entity who benefits from the performance of the service specified in the task (e.g., the patient).
Control | 10..1
Type | Reference(USCorePatientProfile|Resource)
Must Support | true
12. Task.authoredOn
Control | 10..1
Must Support | true
13. Task.requester
Control | 10..1
Type | Reference(USCoreOrganizationProfile|Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson)
Must Support | true
Comments | The organization requesting that this task be performed
Invariants | Defined on this element srx-2: Either requester.reference or requester.identifier SHALL be present (: reference.exists() or identifier.exists())
14. Task.requester.reference
Control | 0..1
Must Support | true
15. Task.requester.identifier
Definition | An identifier of the party reqesting that the task be performed.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Must Support | true
Comments | If the requester is a pharmacy, the identifier SHOULD be an NCPDP Provider Identifier, otherwise if the requester possesses an NPI, an NPI SHOULD be used.
Slicing | This element introduces a set of slices on Task.requester.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ $this
16. Task.requester.identifier:pharmacyNcpdpId
SliceName | pharmacyNcpdpId
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <system value="http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber"/> </valueIdentifier>
17. Task.requester.identifier:pharmacyNcpdpId.value
Control | 1..?
Must Support | true
18. Task.requester.identifier:NPI
SliceName | NPI
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <system value="http://hl7.org/fhir/sid/us-npi"/> </valueIdentifier>
19. Task.requester.identifier:NPI.value
Control | 1..?
Must Support | true
20. Task.owner
Control | 10..1
Type | Reference(Practitioner|PractitionerRole|Organization|CareTeam|HealthcareService|Patient|Device|RelatedPerson)
Must Support | true
Comments | The practitioner that prescribed the related medication Tasks may be created with an owner not yet identified.
Invariants | Defined on this element srx-3: Either owner.reference or owner.identifier SHALL be present (: reference.exists() or identifier.exists())
21. Task.owner.reference
Control | 0..1
Must Support | true
22. Task.owner.identifier
Definition | The prescriber's individual NPI
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Must Support | true
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <system value="http://hl7.org/fhir/sid/us-npi"/> </valueIdentifier>
23. Task.owner.identifier.value
Control | 1..?
Must Support | true
24. Task.reasonReference
Definition | Related prescription order A resource reference indicating why this task needs to be performed.
Type | Reference(MedicationRequest|Resource)
Must Support | true
Comments | The prescription to which the task pertains. Either a reference to a MedicationRequest resource or the prescription identifier set by the prescribing system MAY be present. Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in `Task.reasonCode` if the data is free (uncoded) text.
Invariants | Defined on this element srx-1: If Task.reasonReference is present, either reference or identifier SHOULD be present. If reasonReference.identifier is present, it SHALL be the placer order ID (: reference.exists() or identifier.exists())
25. Task.reasonReference.reference
Definition | Reference to the related MedicationRequest resource
Control | 0..1
Must Support | true
26. Task.reasonReference.identifier
Definition | The prescription order number established by the ordering system
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Must Support | true
Comments | Referred to as the Placer Order Number in HL7 v2 and Prescriber Order Number in NCPDP SCRIPT
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/> <code value="PLAC"/> </coding> </type> </valueIdentifier>
27. Task.reasonReference.identifier.value
Control | 1..?
Must Support | true
28. Task.reasonReference.display
Definition | A human-readable description of the related prescription order
Control | 0..?
Must Support | true
Comments | A human-readable prescription description SHOULD be present. SHOULD contain the medication name and MAY contain the date written. MAY contain strength, dose form, or other specifics.
29. Task.input
Control | 10..*
Must Support | true
Slicing | This element introduces a set of slices on Task.input. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ type
30. Task.input:SmartClientId
SliceName | SmartClientId
Definition | The Client ID of the SMART application to be used to complete this task
Control | 1..1
Must Support | true
31. Task.input:SmartClientId.type
Control | 1..?
Binding | The codes SHALL be taken from Specialty Rx Value Set - Task Input Type This value set contains Task.input types used in the Specialty Rx Task profile
Must Support | true
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic"/> <code value="smart-app-client-id"/> <display value="SMART Application Client ID"/> </coding> </valueCodeableConcept>
32. Task.input:SmartClientId.valueIdentifier
Control | 1..?
Type | Identifier
Must Support | true
33. Task.input:SmartLaunchUrl
SliceName | SmartLaunchUrl
Definition | The launch URL of the SMART application to be used to complete this task
Control | 0..1
Must Support | true
34. Task.input:SmartLaunchUrl.type
Control | 1..?
Binding | The codes SHALL be taken from Specialty Rx Value Set - Task Input Type This value set contains Task.input types used in the Specialty Rx Task profile
Must Support | true
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic"/> <code value="smart-app-launch-url"/> <display value="SMART Application Launch URL"/> </coding> </valueCodeableConcept>
35. Task.input:SmartLaunchUrl.valueUrl
Control | 1..?
Type | url
Must Support | true

Guidance on how to interpret the contents of this table can be found here.

1. Task
Definition | A task to be performed.
Control | 0..*
Summary | false
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) inv-1: Last modified date must be greater than or equal to authored-on date. (: lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn)
2. Task.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 10..1
Type | id string
Must Support | true
Summary | true
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. Task.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Summary | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Task.modifierExtension
Definition | 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
5. Task.identifier
Definition | The business identifier for this task.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..*
Type | Identifier
Must Support | true
Summary | false
Comments | MAY contain multiple task identifiers, but one SHALL be an application context ID to be passed in the appContext parameter while launching the SMART app specified in this Task.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on Task.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ $this
6. Task.identifier:appContext
SliceName | appContext
Definition | A unique identifier representing the context of this task within the SMART application (e.g., the specific set of questions that need to be answered). It is conveyed during launch of the referenced SMART application in the appContext parameter and used by that application to direct the user to information and functions necessary to complete this task. The business identifier for this task.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..1*
Type | Identifier
Must Support | true
Summary | false
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <type> <coding> <system value="http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic"/> <code value="app-context"/> </coding> </type> </valueIdentifier>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Task.identifier:appContext.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Task.identifier:appContext.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Control | 10..1
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Type | CodeableConcept
Must Support | true
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Comments | At least one identifier SHALL be a SMART application contenxt identifier This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Task.identifier:appContext.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Control | 10..1
Type | uri
Must Support | true
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments | Identifier.system is always case sensitive.
Example | General:http://www.acme.com/identifiers/patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Task.identifier:appContext.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control | 10..1
Type | string
Must Support | true
Summary | true
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Example | General:123456
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Task.status
Definition | The current status of the task.
Control | 1..1
Binding | The codes SHALL be taken from TaskStatus The current status of the task.
Type | code
Is Modifier | true
Summary | true
Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Task.intent
Definition | 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.
Control | 1..1
Binding | The codes SHALL be taken from TaskIntent Distinguishes whether the task is a proposal, plan or full order.
Type | code
Must Support | true
Summary | true
Comments | This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order".
Fixed Value | plan
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Task.code
Definition | The SMART app task type: complete-app-questionnaire A name or code (or both) briefly describing what the task involves.
Control | 10..1
Binding | The codes SHALL be taken from Specialty Rx Value Set - Task Type For example codes, see TaskCode Task types used in the Specialty Rx workflow Codes to identify what the task involves. These will typically be specific to a particular workflow.
Type | CodeableConcept
Must Support | true
Summary | true
Comments | Code specifying the requested user action to be performed using the referenced SMART app: complete-app-questionnaire The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic"/> <code value="complete-app-questionnaire"/> <display value="Complete Questionnaire in SMART App"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Task.description
Definition | Human-readable description of the task to be performed by the user. A free-text description of what is to be performed.
Control | 10..1
Type | string
Must Support | true
Summary | true
Comments | SHOULD include the user-recognizable name of the SMART application to launch to perform the task. SHALL state the action to be performed in the app once it's been launched.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Task.for
Definition | The patient for whom the related prescription was written, as represented in the Data Source system The entity who benefits from the performance of the service specified in the task (e.g., the patient).
Control | 10..1
Type | Reference(USCorePatientProfile|Resource)
Must Support | true
Summary | true
Requirements | Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control.
Alternate Names | Patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Task.authoredOn
Definition | The date and time this task was created.
Control | 10..1 This element is affected by the following invariants: inv-1
Type | dateTime
Must Support | true
Summary | false
Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management.
Alternate Names | Created Date
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Task.requester
Definition | The creator of the task.
Control | 10..1
Type | Reference(USCoreOrganizationProfile|Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson)
Must Support | true
Summary | true
Requirements | Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).
Comments | The organization requesting that this task be performed
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) srx-2: Either requester.reference or requester.identifier SHALL be present (: reference.exists() or identifier.exists())
18. Task.requester.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Must Support | true
Summary | true
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Task.requester.identifier
Definition | An identifier of the party reqesting that the task be performed. An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Summary | true
Comments | If the requester is a pharmacy, the identifier SHOULD be an NCPDP Provider Identifier, otherwise if the requester possesses an NPI, an NPI SHOULD be used. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on Task.requester.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ $this
20. Task.requester.identifier:pharmacyNcpdpId
SliceName | pharmacyNcpdpId
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Summary | true
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <system value="http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber"/> </valueIdentifier>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Task.requester.identifier:pharmacyNcpdpId.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Task.requester.identifier:pharmacyNcpdpId.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control | 10..1
Type | string
Must Support | true
Summary | true
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Example | General:123456
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Task.requester.identifier:NPI
SliceName | NPI
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Summary | true
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <system value="http://hl7.org/fhir/sid/us-npi"/> </valueIdentifier>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Task.requester.identifier:NPI.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Task.requester.identifier:NPI.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control | 10..1
Type | string
Must Support | true
Summary | true
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Example | General:123456
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Task.owner
Definition | Individual organization or Device currently responsible for task execution.
Control | 10..1
Type | Reference(Practitioner|PractitionerRole|Organization|CareTeam|HealthcareService|Patient|Device|RelatedPerson)
Must Support | true
Summary | true
Requirements | Identifies who is expected to perform this task.
Alternate Names | Performer, Executer
Comments | The practitioner that prescribed the related medication Tasks may be created with an owner not yet identified.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) srx-3: Either owner.reference or owner.identifier SHALL be present (: reference.exists() or identifier.exists())
27. Task.owner.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Must Support | true
Summary | true
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Task.owner.identifier
Definition | The prescriber's individual NPI An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Summary | true
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <system value="http://hl7.org/fhir/sid/us-npi"/> </valueIdentifier>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Task.owner.identifier.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Task.owner.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control | 10..1
Type | string
Must Support | true
Summary | true
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Example | General:123456
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. Task.reasonReference
Definition | Related prescription order A resource reference indicating why this task needs to be performed.
Control | 0..1
Type | Reference(MedicationRequest|Resource)
Must Support | true
Summary | false
Comments | The prescription to which the task pertains. Either a reference to a MedicationRequest resource or the prescription identifier set by the prescribing system MAY be present. Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in `Task.reasonCode` if the data is free (uncoded) text.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) srx-1: If Task.reasonReference is present, either reference or identifier SHOULD be present. If reasonReference.identifier is present, it SHALL be the placer order ID (: reference.exists() or identifier.exists())
32. Task.reasonReference.reference
Definition | Reference to the related MedicationRequest resource A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Must Support | true
Summary | true
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. Task.reasonReference.identifier
Definition | The prescription order number established by the ordering system An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Summary | true
Comments | Referred to as the Placer Order Number in HL7 v2 and Prescriber Order Number in NCPDP SCRIPT When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/> <code value="PLAC"/> </coding> </type> </valueIdentifier>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. Task.reasonReference.identifier.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Task.reasonReference.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control | 10..1
Type | string
Must Support | true
Summary | true
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Example | General:123456
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Task.reasonReference.display
Definition | A human-readable description of the related prescription order Plain text narrative that identifies the resource in addition to the resource reference.
Control | 0..1
Type | string
Must Support | true
Summary | true
Comments | A human-readable prescription description SHOULD be present. SHOULD contain the medication name and MAY contain the date written. MAY contain strength, dose form, or other specifics. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Task.input
Definition | Additional information that may be needed in the execution of the task.
Control | 10..*
Type | BackboneElement
Must Support | true
Summary | false
Requirements | Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.
Alternate Names | Supporting Information
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on Task.input. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ type
38. Task.input.modifierExtension
Definition | 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
39. Task.input.type
Definition | A code or description indicating how the input is intended to be used as part of the task execution.
Control | 1..1
Binding | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
Type | CodeableConcept
Summary | false
Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next.
Alternate Names | Name
Comments | If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Task.input.value[x]
Definition | The value of the input parameter as a basic type.
Control | 1..1
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] Note | See Choice of Data Types for further information about how to use [x]
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. Task.input:SmartClientId
SliceName | SmartClientId
Definition | The Client ID of the SMART application to be used to complete this task Additional information that may be needed in the execution of the task.
Control | 10..1*
Type | BackboneElement
Must Support | true
Summary | false
Requirements | Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.
Alternate Names | Supporting Information
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. Task.input:SmartClientId.modifierExtension
Definition | 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
43. Task.input:SmartClientId.type
Definition | A code or description indicating how the input is intended to be used as part of the task execution.
Control | 1..1
Binding | The codes SHALL be taken from Specialty Rx Value Set - Task Input Type For example codes, see (unbound) This value set contains Task.input types used in the Specialty Rx Task profiles Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
Type | CodeableConcept
Must Support | true
Summary | false
Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next.
Alternate Names | Name
Comments | If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic"/> <code value="smart-app-client-id"/> <display value="SMART Application Client ID"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Task.input:SmartClientId.value[x]
Definition | The value of the input parameter as a basic type.
Control | 1..1
Type | Choice of: Identifier, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. Task.input:SmartLaunchUrl
SliceName | SmartLaunchUrl
Definition | The launch URL of the SMART application to be used to complete this task Additional information that may be needed in the execution of the task.
Control | 0..1*
Type | BackboneElement
Must Support | true
Summary | false
Requirements | Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.
Alternate Names | Supporting Information
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. Task.input:SmartLaunchUrl.modifierExtension
Definition | 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
47. Task.input:SmartLaunchUrl.type
Definition | A code or description indicating how the input is intended to be used as part of the task execution.
Control | 1..1
Binding | The codes SHALL be taken from Specialty Rx Value Set - Task Input Type For example codes, see (unbound) This value set contains Task.input types used in the Specialty Rx Task profiles Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
Type | CodeableConcept
Must Support | true
Summary | false
Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next.
Alternate Names | Name
Comments | If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic"/> <code value="smart-app-launch-url"/> <display value="SMART Application Launch URL"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. Task.input:SmartLaunchUrl.value[x]
Definition | The value of the input parameter as a basic type.
Control | 1..1
Type | Choice of: url, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. Task
Definition | A task to be performed.
Control | 0..*
Summary | false
2. Task.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 1..1
Type | id
Must Support | true
Summary | true
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. Task.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Task.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Summary | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Task.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Summary | false
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Task.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control | 0..1
Type | Narrative
Summary | false
Alternate Names | narrative, html, xhtml, display
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Task.contained
Definition | 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.
Control | 0..*
Type | Resource
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
8. Task.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. Task.modifierExtension
Definition | 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Task.identifier
Definition | The business identifier for this task.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..*
Type | Identifier
Must Support | true
Summary | false
Comments | MAY contain multiple task identifiers, but one SHALL be an application context ID to be passed in the appContext parameter while launching the SMART app specified in this Task.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on Task.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ $this
11. Task.identifier:appContext
SliceName | appContext
Definition | A unique identifier representing the context of this task within the SMART application (e.g., the specific set of questions that need to be answered). It is conveyed during launch of the referenced SMART application in the appContext parameter and used by that application to direct the user to information and functions necessary to complete this task.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Type | Identifier
Must Support | true
Summary | false
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <type> <coding> <system value="http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic"/> <code value="app-context"/> </coding> </type> </valueIdentifier>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Task.identifier:appContext.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
13. Task.identifier:appContext.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Task.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
14. Task.identifier:appContext.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Type | code
Is Modifier | true
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Task.identifier:appContext.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Control | 1..1
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
Type | CodeableConcept
Must Support | true
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Comments | At least one identifier SHALL be a SMART application contenxt identifier
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Task.identifier:appContext.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Control | 1..1
Type | uri
Must Support | true
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments | Identifier.system is always case sensitive.
Example | General:http://www.acme.com/identifiers/patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Task.identifier:appContext.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control | 1..1
Type | string
Must Support | true
Summary | true
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Example | General:123456
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Task.identifier:appContext.period
Definition | Time period during which identifier is/was valid for use.
Control | 0..1
Type | Period
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Task.identifier:appContext.assigner
Definition | Organization that issued/manages the identifier.
Control | 0..1
Type | Reference(Organization)
Summary | true
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Task.instantiatesCanonical
Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
Control | 0..1
Type | canonical(ActivityDefinition)
Summary | true
Requirements | Enables a formal definition of how he task is to be performed, enabling automation.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Task.instantiatesUri
Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
Control | 0..1
Type | uri
Summary | true
Requirements | Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation to be associated with a task), enabling automation.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Task.basedOn
Definition | 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.
Control | 0..*
Type | Reference(Resource)
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Task.groupIdentifier
Definition | An identifier that links together multiple tasks and other requests that were created in the same context.
Control | 0..1
Type | Identifier
Summary | true
Requirements | Billing and/or reporting can be linked to whether multiple requests were created as a single unit.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Task.partOf
Definition | Task that this particular task is part of.
Control | 0..*
Type | Reference(Task)
Summary | true
Requirements | Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).
Comments | This should usually be 0..1.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Task.status
Definition | The current status of the task.
Control | 1..1
Binding | The codes SHALL be taken from TaskStatus The current status of the task
Type | code
Is Modifier | true
Summary | true
Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Task.statusReason
Definition | An explanation as to why this task is held, failed, was refused, etc.
Control | 0..1
Binding | Codes to identify the reason for current status. These will typically be specific to a particular workflow.
Type | CodeableConcept
Summary | true
Comments | This applies to the current status. Look at the history of the task to see reasons for past statuses.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Task.businessStatus
Definition | Contains business-specific nuances of the business state.
Control | 0..1
Binding | The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.
Type | CodeableConcept
Summary | true
Requirements | There's often a need to track substates of a task - this is often variable by specific workflow implementation.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Task.intent
Definition | 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.
Control | 1..1
Binding | The codes SHALL be taken from TaskIntent Distinguishes whether the task is a proposal, plan or full order
Type | code
Must Support | true
Summary | true
Comments | This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order".
Fixed Value | plan
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Task.priority
Definition | Indicates how quickly the Task should be addressed with respect to other requests.
Control | 0..1
Binding | The codes SHALL be taken from RequestPriority The task's priority
Type | code
Summary | false
Requirements | Used to identify the service level expected while performing a task.
Meaning if Missing | If missing, this task should be performed with normal priority
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Task.code
Definition | The SMART app task type: complete-app-questionnaire
Control | 1..1
Binding | The codes SHALL be taken from Specialty Rx Value Set - Task Type Task types used in the Specialty Rx workflo
Type | CodeableConcept
Must Support | true
Summary | true
Comments | Code specifying the requested user action to be performed using the referenced SMART app: complete-app-questionnaire
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic"/> <code value="complete-app-questionnaire"/> <display value="Complete Questionnaire in SMART App"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. Task.description
Definition | Human-readable description of the task to be performed by the user.
Control | 1..1
Type | string
Must Support | true
Summary | true
Comments | SHOULD include the user-recognizable name of the SMART application to launch to perform the task. SHALL state the action to be performed in the app once it's been launched.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Task.focus
Definition | The request being actioned or the resource being manipulated by this task.
Control | 0..1
Type | Reference(Resource)
Summary | true
Requirements | Used to identify the thing to be done.
Comments | If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. Task.for
Definition | The patient for whom the related prescription was written, as represented in the Data Source system
Control | 1..1
Type | Reference(USCorePatientProfile)
Must Support | true
Summary | true
Requirements | Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control.
Alternate Names | Patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. Task.encounter
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
Control | 0..1
Type | Reference(Encounter)
Summary | true
Requirements | For some tasks it may be important to know the link between the encounter the task originated within.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Task.executionPeriod
Definition | Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).
Control | 0..1
Type | Period
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Task.authoredOn
Definition | The date and time this task was created.
Control | 1..1 This element is affected by the following invariants: inv-1
Type | dateTime
Must Support | true
Summary | false
Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management.
Alternate Names | Created Date
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Task.lastModified
Definition | The date and time of last modification to this task.
Control | 0..1 This element is affected by the following invariants: inv-1
Type | dateTime
Summary | true
Requirements | Used along with history to track task activity and time in a particular task state. This enables monitoring and management.
Alternate Names | Update Date
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Task.requester
Definition | The creator of the task.
Control | 1..1
Type | Reference(USCoreOrganizationProfile)
Must Support | true
Summary | true
Requirements | Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).
Comments | The organization requesting that this task be performed
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) srx-2: Either requester.reference or requester.identifier SHALL be present (: reference.exists() or identifier.exists())
39. Task.requester.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
40. Task.requester.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Task.requester.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
41. Task.requester.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Must Support | true
Summary | true
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. Task.requester.type
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Control | 0..1
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model)
Type | uri
Summary | true
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. Task.requester.identifier
Definition | An identifier of the party reqesting that the task be performed.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Summary | true
Comments | If the requester is a pharmacy, the identifier SHOULD be an NCPDP Provider Identifier, otherwise if the requester possesses an NPI, an NPI SHOULD be used.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on Task.requester.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ $this
44. Task.requester.identifier:pharmacyNcpdpId
SliceName | pharmacyNcpdpId
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Summary | true
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <system value="http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber"/> </valueIdentifier>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. Task.requester.identifier:pharmacyNcpdpId.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
46. Task.requester.identifier:pharmacyNcpdpId.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Task.requester.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
47. Task.requester.identifier:pharmacyNcpdpId.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Type | code
Is Modifier | true
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. Task.requester.identifier:pharmacyNcpdpId.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Control | 0..1
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
Type | CodeableConcept
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. Task.requester.identifier:pharmacyNcpdpId.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Control | 0..1
Type | uri
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments | Identifier.system is always case sensitive.
Example | General:http://www.acme.com/identifiers/patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. Task.requester.identifier:pharmacyNcpdpId.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control | 1..1
Type | string
Must Support | true
Summary | true
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Example | General:123456
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. Task.requester.identifier:pharmacyNcpdpId.period
Definition | Time period during which identifier is/was valid for use.
Control | 0..1
Type | Period
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. Task.requester.identifier:pharmacyNcpdpId.assigner
Definition | Organization that issued/manages the identifier.
Control | 0..1
Type | Reference(Organization)
Summary | true
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. Task.requester.identifier:NPI
SliceName | NPI
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Summary | true
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <system value="http://hl7.org/fhir/sid/us-npi"/> </valueIdentifier>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Task.requester.identifier:NPI.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
55. Task.requester.identifier:NPI.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Task.requester.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
56. Task.requester.identifier:NPI.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Type | code
Is Modifier | true
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. Task.requester.identifier:NPI.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Control | 0..1
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
Type | CodeableConcept
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. Task.requester.identifier:NPI.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Control | 0..1
Type | uri
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments | Identifier.system is always case sensitive.
Example | General:http://www.acme.com/identifiers/patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. Task.requester.identifier:NPI.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control | 1..1
Type | string
Must Support | true
Summary | true
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Example | General:123456
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. Task.requester.identifier:NPI.period
Definition | Time period during which identifier is/was valid for use.
Control | 0..1
Type | Period
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. Task.requester.identifier:NPI.assigner
Definition | Organization that issued/manages the identifier.
Control | 0..1
Type | Reference(Organization)
Summary | true
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. Task.requester.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Control | 0..1
Type | string
Summary | true
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. Task.performerType
Definition | The kind of participant that should perform the task.
Control | 0..*
Binding | The codes SHOULD be taken from ProcedurePerformerRoleCodes The type(s) of task performers allowed
Type | CodeableConcept
Summary | false
Requirements | Use to distinguish tasks on different activity queues.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. Task.owner
Definition | Individual organization or Device currently responsible for task execution.
Control | 1..1
Type | Reference(Practitioner)
Must Support | true
Summary | true
Requirements | Identifies who is expected to perform this task.
Alternate Names | Performer, Executer
Comments | The practitioner that prescribed the related medication
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) srx-3: Either owner.reference or owner.identifier SHALL be present (: reference.exists() or identifier.exists())
65. Task.owner.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
66. Task.owner.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Task.owner.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
67. Task.owner.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Must Support | true
Summary | true
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
68. Task.owner.type
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Control | 0..1
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model)
Type | uri
Summary | true
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
69. Task.owner.identifier
Definition | The prescriber's individual NPI
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Summary | true
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <system value="http://hl7.org/fhir/sid/us-npi"/> </valueIdentifier>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
70. Task.owner.identifier.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
71. Task.owner.identifier.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Task.owner.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
72. Task.owner.identifier.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Type | code
Is Modifier | true
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
73. Task.owner.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Control | 0..1
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
Type | CodeableConcept
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
74. Task.owner.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Control | 0..1
Type | uri
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments | Identifier.system is always case sensitive.
Example | General:http://www.acme.com/identifiers/patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
75. Task.owner.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control | 1..1
Type | string
Must Support | true
Summary | true
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Example | General:123456
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
76. Task.owner.identifier.period
Definition | Time period during which identifier is/was valid for use.
Control | 0..1
Type | Period
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
77. Task.owner.identifier.assigner
Definition | Organization that issued/manages the identifier.
Control | 0..1
Type | Reference(Organization)
Summary | true
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
78. Task.owner.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Control | 0..1
Type | string
Summary | true
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
79. Task.location
Definition | Principal physical location where the this task is performed.
Control | 0..1
Type | Reference(Location)
Summary | true
Requirements | Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
80. Task.reasonCode
Definition | A description or code indicating why this task needs to be performed.
Control | 0..1
Binding | Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.
Type | CodeableConcept
Summary | false
Comments | This should only be included if there is no focus or if it differs from the reason indicated on the focus.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
81. Task.reasonReference
Definition | Related prescription order
Control | 0..1
Type | Reference(MedicationRequest)
Must Support | true
Summary | false
Comments | The prescription to which the task pertains. Either a reference to a MedicationRequest resource or the prescription identifier set by the prescribing system MAY be present.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) srx-1: If Task.reasonReference is present, either reference or identifier SHOULD be present. If reasonReference.identifier is present, it SHALL be the placer order ID (: reference.exists() or identifier.exists())
82. Task.reasonReference.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
83. Task.reasonReference.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Task.reasonReference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
84. Task.reasonReference.reference
Definition | Reference to the related MedicationRequest resource
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Must Support | true
Summary | true
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
85. Task.reasonReference.type
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Control | 0..1
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model)
Type | uri
Summary | true
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
86. Task.reasonReference.identifier
Definition | The prescription order number established by the ordering system
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Must Support | true
Summary | true
Comments | Referred to as the Placer Order Number in HL7 v2 and Prescriber Order Number in NCPDP SCRIPT
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/> <code value="PLAC"/> </coding> </type> </valueIdentifier>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
87. Task.reasonReference.identifier.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
88. Task.reasonReference.identifier.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
Slicing | This element introduces a set of slices on Task.reasonReference.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
89. Task.reasonReference.identifier.use
Definition | The purpose of this identifier.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Type | code
Is Modifier | true
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
90. Task.reasonReference.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Control | 0..1
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
Type | CodeableConcept
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
91. Task.reasonReference.identifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Control | 0..1
Type | uri
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments | Identifier.system is always case sensitive.
Example | General:http://www.acme.com/identifiers/patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
92. Task.reasonReference.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Control | 1..1
Type | string
Must Support | true
Summary | true
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Example | General:123456
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
93. Task.reasonReference.identifier.period
Definition | Time period during which identifier is/was valid for use.
Control | 0..1
Type | Period
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
94. Task.reasonReference.identifier.assigner
Definition | Organization that issued/manages the identifier.
Control | 0..1
Type | Reference(Organization)
Summary | true
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
95. Task.reasonReference.display
Definition | A human-readable description of the related prescription order
Control | 0..1
Type | string
Must Support | true
Summary | true
Comments | A human-readable prescription description SHOULD be present. SHOULD contain the medication name and MAY contain the date written. MAY contain strength, dose form, or other specifics.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
96. Task.insurance
Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
Control | 0..*
Type | Reference(Coverage|ClaimResponse)
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
97. Task.note
Definition | Free-text information captured about the task as it progresses.
Control | 0..*
Type | Annotation
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
98. Task.relevantHistory
Definition | 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.
Control | 0..*
Type | Reference(Provenance)
Summary | false
Alternate Names | Status History
Comments | This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
99. Task.restriction
Definition | If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
Control | 0..1
Type | BackboneElement
Summary | false
Requirements | Sometimes when fulfillment is sought, you don't want full fulfillment.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
100. Task.restriction.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
101. Task.restriction.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
102. Task.restriction.modifierExtension
Definition | 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
103. Task.restriction.repetitions
Definition | Indicates the number of times the requested action should occur.
Control | 0..1
Type | positiveInt
Summary | false
Requirements | E.g. order that requests monthly lab tests, fulfillment is sought for 1.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
104. Task.restriction.period
Definition | Over what time-period is fulfillment sought.
Control | 0..1
Type | Period
Summary | false
Requirements | E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.
Comments | Note that period.high is the due date representing the time by which the task should be completed.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
105. Task.restriction.recipient
Definition | For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?
Control | 0..*
Type | Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|Group|Organization)
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
106. Task.input
Definition | Additional information that may be needed in the execution of the task.
Control | 1..*
Type | BackboneElement
Must Support | true
Summary | false
Requirements | Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.
Alternate Names | Supporting Information
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on Task.input. The slices are unordered and Open, and can be differentiated using the following discriminators: pattern @ type
107. Task.input.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
108. Task.input.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
109. Task.input.modifierExtension
Definition | 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
110. Task.input.type
Definition | A code or description indicating how the input is intended to be used as part of the task execution.
Control | 1..1
Binding | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
Type | CodeableConcept
Summary | false
Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next.
Alternate Names | Name
Comments | If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
111. Task.input.value[x]
Definition | The value of the input parameter as a basic type.
Control | 1..1
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] Note | See Choice of Data Types for further information about how to use [x]
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
112. Task.input:SmartClientId
SliceName | SmartClientId
Definition | The Client ID of the SMART application to be used to complete this task
Control | 1..1
Type | BackboneElement
Must Support | true
Summary | false
Requirements | Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.
Alternate Names | Supporting Information
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
113. Task.input:SmartClientId.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
114. Task.input:SmartClientId.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
115. Task.input:SmartClientId.modifierExtension
Definition | 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
116. Task.input:SmartClientId.type
Definition | A code or description indicating how the input is intended to be used as part of the task execution.
Control | 1..1
Binding | The codes SHALL be taken from Specialty Rx Value Set - Task Input Type This value set contains Task.input types used in the Specialty Rx Task profile
Type | CodeableConcept
Must Support | true
Summary | false
Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next.
Alternate Names | Name
Comments | If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic"/> <code value="smart-app-client-id"/> <display value="SMART Application Client ID"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
117. Task.input:SmartClientId.value[x]
Definition | The value of the input parameter as a basic type.
Control | 1..1
Type | Identifier
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
118. Task.input:SmartLaunchUrl
SliceName | SmartLaunchUrl
Definition | The launch URL of the SMART application to be used to complete this task
Control | 0..1
Type | BackboneElement
Must Support | true
Summary | false
Requirements | Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.
Alternate Names | Supporting Information
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
119. Task.input:SmartLaunchUrl.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
120. Task.input:SmartLaunchUrl.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
121. Task.input:SmartLaunchUrl.modifierExtension
Definition | 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
122. Task.input:SmartLaunchUrl.type
Definition | A code or description indicating how the input is intended to be used as part of the task execution.
Control | 1..1
Binding | The codes SHALL be taken from Specialty Rx Value Set - Task Input Type This value set contains Task.input types used in the Specialty Rx Task profile
Type | CodeableConcept
Must Support | true
Summary | false
Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next.
Alternate Names | Name
Comments | If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic"/> <code value="smart-app-launch-url"/> <display value="SMART Application Launch URL"/> </coding> </valueCodeableConcept>
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
123. Task.input:SmartLaunchUrl.value[x]
Definition | The value of the input parameter as a basic type.
Control | 1..1
Type | url
[x] Note | See Choice of Data Types for further information about how to use [x]
Must Support | true
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
124. Task.output
Definition | Outputs produced by the Task.
Control | 0..*
Type | BackboneElement
Summary | false
Requirements | Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
125. Task.output.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
126. Task.output.extension
Definition | 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
127. Task.output.modifierExtension
Definition | 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
128. Task.output.type
Definition | The name of the Output parameter.
Control | 1..1
Binding | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.
Type | CodeableConcept
Summary | false
Requirements | Outputs are named to enable task automation to bind data and pass it from one task to the next.
Alternate Names | Name
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
129. Task.output.value[x]
Definition | The value of the Output parameter as a basic type.
Control | 1..1
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] Note | See Choice of Data Types for further information about how to use [x]
Summary | false
Requirements | Task outputs can take any form.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))