This page is part of the Specialty Medication Enrollment (v2.0.0: STU2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-task-smart-launch | Version: 2.0.0 | |||
Active as of 2021-03-02 | Computable Name: SpecialtyRxTaskSmartLaunch |
This profile defines Task content enabling a pharmacy or other external party to prompt clinic staff to launch a SMART app and answer prescription-related questions.
This profile ensures that the Task conveys the information that the EHR needs to…
__appContext
parameterThe Task.identifier value (representing application context associated with the Task) is shared during SMART app launch within the __appContext
parameter of the OAuth 2.0 access token response. It is conveyed in the __appContext
parameter.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Task
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | 0..* | Task | A task to be performed | |
id | S | 1..1 | id | Logical id of this artifact |
Slices for identifier | S | 1..* | Identifier | Task Instance Identifier Slice: Unordered, Open by pattern:$this |
identifier:appContext | S | 1..1 | Identifier | SMART App Context ID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: app-context | |
type | S | 1..1 | CodeableConcept | Description of identifier |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
intent | S | 1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: plan |
code | S | 1..1 | CodeableConcept | Task Type Binding: Specialty Rx Value Set - Task Type (required): Task types used in the Specialty Rx workflow Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: complete-app-questionnaire | |
display | 1..1 | string | Representation defined by the system Fixed Value: Complete Questionnaire in SMART App | |
description | S | 1..1 | string | Human-readable explanation of task |
for | S | 1..1 | Reference(US Core Patient Profile) | Related Patient in Data Source |
authoredOn | S | 1..1 | dateTime | Task Creation Date |
requester | SC | 1..1 | Reference(US Core Organization Profile) | Who is asking for task to be done srx-2: Either requester.reference or requester.identifier SHALL be present |
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
Slices for identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known Slice: Unordered, Open by pattern:$this |
identifier:pharmacyNcpdpId | S | 0..1 | Identifier | The pharmacy's NCPDP Provider ID Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber | |
value | S | 1..1 | string | The value that is unique |
identifier:NPI | S | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
value | S | 1..1 | string | The value that is unique |
owner | SC | 1..1 | Reference(Practitioner) | Prescriber srx-3: Either owner.reference or owner.identifier SHALL be present |
reference | S | 0..1 | string | Prescriber Reference |
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
value | S | 1..1 | string | The value that is unique |
reasonReference | SC | 0..1 | Reference(MedicationRequest) | Related Prescription 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 | S | 0..1 | string | Prescription Reference |
identifier | S | 0..1 | Identifier | Placer Order Number Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
value | S | 1..1 | string | The value that is unique |
display | S | 0..1 | string | Text alternative for the resource |
Slices for input | S | 1..* | BackboneElement | Information used to perform task Slice: Unordered, Open by pattern:type |
input:SmartClientId | S | 1..1 | BackboneElement | SMART App Client ID |
type | S | 1..1 | CodeableConcept | Label for the input Binding: Specialty Rx Value Set - Task Input Type (required): This value set contains Task.input types used in the Specialty Rx Task profiles Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: smart-app-client-id | |
display | 1..1 | string | Representation defined by the system Fixed Value: SMART Application Client ID | |
valueIdentifier | S | 1..1 | Identifier | SMART App Client ID |
input:SmartLaunchUrl | S | 0..1 | BackboneElement | Smart App Launch URL |
type | S | 1..1 | CodeableConcept | Label for the input Binding: Specialty Rx Value Set - Task Input Type (required): This value set contains Task.input types used in the Specialty Rx Task profiles Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: smart-app-launch-url | |
display | 1..1 | string | Representation defined by the system Fixed Value: SMART Application Launch URL | |
valueUrl | S | 1..1 | url | SMART launch URL |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Task.code | required | Pattern: complete-app-questionnaire("Complete Questionnaire in SMART App") |
Task.input:SmartClientId.type | required | Pattern: smart-app-client-id("SMART Application Client ID") |
Task.input:SmartLaunchUrl.type | required | Pattern: smart-app-launch-url("SMART Application Launch URL") |
Id | Grade | Path(s) | Details | Requirements |
srx-1 | warning | Task.reasonReference | 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() | |
srx-2 | error | Task.requester | Either requester.reference or requester.identifier SHALL be present : reference.exists() or identifier.exists() | |
srx-3 | error | Task.owner | Either owner.reference or owner.identifier SHALL be present : reference.exists() or identifier.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | C | 0..* | Task | A task to be performed |
id | SΣ | 1..1 | id | Logical id of this artifact |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | S | 1..* | Identifier | Task Instance Identifier Slice: Unordered, Open by pattern:$this |
identifier:appContext | S | 1..1 | Identifier | SMART App Context ID Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: app-context | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. |
intent | SΣ | 1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: plan |
code | SΣ | 1..1 | CodeableConcept | Task Type Binding: Specialty Rx Value Set - Task Type (required): Task types used in the Specialty Rx workflow Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: complete-app-questionnaire | |
display | 1..1 | string | Representation defined by the system Fixed Value: Complete Questionnaire in SMART App | |
description | SΣ | 1..1 | string | Human-readable explanation of task |
for | SΣ | 1..1 | Reference(US Core Patient Profile) | Related Patient in Data Source |
authoredOn | SC | 1..1 | dateTime | Task Creation Date |
requester | SΣC | 1..1 | Reference(US Core Organization Profile) | Who is asking for task to be done srx-2: Either requester.reference or requester.identifier SHALL be present |
reference | SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
Slices for identifier | SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known Slice: Unordered, Open by pattern:$this |
identifier:pharmacyNcpdpId | SΣ | 0..1 | Identifier | The pharmacy's NCPDP Provider ID Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
identifier:NPI | SΣ | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
owner | SΣC | 1..1 | Reference(Practitioner) | Prescriber srx-3: Either owner.reference or owner.identifier SHALL be present |
reference | SΣC | 0..1 | string | Prescriber Reference |
identifier | SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
reasonReference | SC | 0..1 | Reference(MedicationRequest) | Related Prescription 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 | SΣC | 0..1 | string | Prescription Reference |
identifier | SΣ | 0..1 | Identifier | Placer Order Number Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
display | SΣ | 0..1 | string | Text alternative for the resource |
Slices for input | S | 1..* | BackboneElement | Information used to perform task Slice: Unordered, Open by pattern:type |
input:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding: (unbound) (example): 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. | |
value[x] | 1..1 | Content to use in performing the task | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
input:SmartClientId | S | 1..1 | BackboneElement | SMART App Client ID |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 1..1 | CodeableConcept | Label for the input Binding: Specialty Rx Value Set - Task Input Type (required): This value set contains Task.input types used in the Specialty Rx Task profiles Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: smart-app-client-id | |
display | 1..1 | string | Representation defined by the system Fixed Value: SMART Application Client ID | |
value[x] | S | 1..1 | Identifier | SMART App Client ID |
input:SmartLaunchUrl | S | 0..1 | BackboneElement | Smart App Launch URL |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | S | 1..1 | CodeableConcept | Label for the input Binding: Specialty Rx Value Set - Task Input Type (required): This value set contains Task.input types used in the Specialty Rx Task profiles Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: smart-app-launch-url | |
display | 1..1 | string | Representation defined by the system Fixed Value: SMART Application Launch URL | |
value[x] | S | 1..1 | url | SMART launch URL |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Task.identifier:appContext.use | required | IdentifierUse |
Task.identifier:appContext.type | extensible | Identifier Type Codes |
Task.status | required | TaskStatus |
Task.intent | required | Fixed Value: plan |
Task.code | required | Pattern: complete-app-questionnaire("Complete Questionnaire in SMART App") |
Task.requester.identifier:pharmacyNcpdpId.use | required | IdentifierUse |
Task.requester.identifier:NPI.use | required | IdentifierUse |
Task.owner.identifier.use | required | IdentifierUse |
Task.reasonReference.identifier.use | required | IdentifierUse |
Task.input.type | example | |
Task.input:SmartClientId.type | required | Pattern: smart-app-client-id("SMART Application Client ID") |
Task.input:SmartLaunchUrl.type | required | Pattern: smart-app-launch-url("SMART Application Launch URL") |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Task | 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 | error | Task | 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 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn | |
srx-1 | warning | Task.reasonReference | 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() | |
srx-2 | error | Task.requester | Either requester.reference or requester.identifier SHALL be present : reference.exists() or identifier.exists() | |
srx-3 | error | Task.owner | Either owner.reference or owner.identifier SHALL be present : reference.exists() or identifier.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Task | C | 0..* | Task | A task to be performed | ||||
id | SΣ | 1..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | S | 1..* | Identifier | Task Instance Identifier Slice: Unordered, Open by pattern:$this | ||||
identifier:appContext | S | 1..1 | Identifier | SMART App Context ID Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: app-context | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 0..1 | uri | The namespace for the identifier value | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
instantiatesUri | Σ | 0..1 | uri | Formal definition of task | ||||
basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
groupIdentifier | Σ | 0..1 | Identifier | Requisition or grouper id | ||||
partOf | Σ | 0..* | Reference(Task) | Composite task | ||||
status | ?!Σ | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. | ||||
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
businessStatus | Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding: (unbound) (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
intent | SΣ | 1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: plan | ||||
priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. | |||||
code | SΣ | 1..1 | CodeableConcept | Task Type Binding: Specialty Rx Value Set - Task Type (required): Task types used in the Specialty Rx workflow Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: complete-app-questionnaire | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Complete Questionnaire in SMART App | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
description | SΣ | 1..1 | string | Human-readable explanation of task | ||||
focus | Σ | 0..1 | Reference(Resource) | What task is acting on | ||||
for | SΣ | 1..1 | Reference(US Core Patient Profile) | Related Patient in Data Source | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated | ||||
executionPeriod | Σ | 0..1 | Period | Start and end time of execution | ||||
authoredOn | SC | 1..1 | dateTime | Task Creation Date | ||||
lastModified | ΣC | 0..1 | dateTime | Task Last Modified Date | ||||
requester | SΣC | 1..1 | Reference(US Core Organization Profile) | Who is asking for task to be done srx-2: Either requester.reference or requester.identifier SHALL be present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
Slices for identifier | SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known Slice: Unordered, Open by pattern:$this | ||||
identifier:pharmacyNcpdpId | SΣ | 0..1 | Identifier | The pharmacy's NCPDP Provider ID Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:NPI | SΣ | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
performerType | 0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
owner | SΣC | 1..1 | Reference(Practitioner) | Prescriber srx-3: Either owner.reference or owner.identifier SHALL be present | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | SΣC | 0..1 | string | Prescriber Reference | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
location | Σ | 0..1 | Reference(Location) | Where task occurs | ||||
reasonCode | 0..1 | CodeableConcept | Why task is needed Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
reasonReference | SC | 0..1 | Reference(MedicationRequest) | Related Prescription 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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | SΣC | 0..1 | string | Prescription Reference | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | SΣ | 0..1 | Identifier | Placer Order Number Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | 0..1 | uri | The namespace for the identifier value | |||||
value | 0..1 | string | The value that is unique | |||||
period | 0..1 | Period | Time period when id is/was valid for use | |||||
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | SΣ | 0..1 | string | Text alternative for the resource | ||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
note | 0..* | Annotation | Comments made about the task | |||||
relevantHistory | 0..* | Reference(Provenance) | Key events in history of the Task | |||||
restriction | 0..1 | BackboneElement | Constraints on fulfillment tasks | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
repetitions | 0..1 | positiveInt | How many times to repeat | |||||
period | 0..1 | Period | When fulfillment sought | |||||
recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
Slices for input | S | 1..* | BackboneElement | Information used to perform task Slice: Unordered, Open by pattern:type | ||||
input:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding: (unbound) (example): 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. | |||||
value[x] | 1..1 | Content to use in performing the task | ||||||
valueBase64Binary | base64Binary | |||||||
valueBoolean | boolean | |||||||
valueCanonical | canonical(Any) | |||||||
valueCode | code | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
valueId | id | |||||||
valueInstant | instant | |||||||
valueInteger | integer | |||||||
valueMarkdown | markdown | |||||||
valueOid | oid | |||||||
valuePositiveInt | positiveInt | |||||||
valueString | string | |||||||
valueTime | time | |||||||
valueUnsignedInt | unsignedInt | |||||||
valueUri | uri | |||||||
valueUrl | url | |||||||
valueUuid | uuid | |||||||
valueAddress | Address | |||||||
valueAge | Age | |||||||
valueAnnotation | Annotation | |||||||
valueAttachment | Attachment | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueCoding | Coding | |||||||
valueContactPoint | ContactPoint | |||||||
valueCount | Count | |||||||
valueDistance | Distance | |||||||
valueDuration | Duration | |||||||
valueHumanName | HumanName | |||||||
valueIdentifier | Identifier | |||||||
valueMoney | Money | |||||||
valuePeriod | Period | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueReference | Reference(Any) | |||||||
valueSampledData | SampledData | |||||||
valueSignature | Signature | |||||||
valueTiming | Timing | |||||||
valueContactDetail | ContactDetail | |||||||
valueContributor | Contributor | |||||||
valueDataRequirement | DataRequirement | |||||||
valueExpression | Expression | |||||||
valueParameterDefinition | ParameterDefinition | |||||||
valueRelatedArtifact | RelatedArtifact | |||||||
valueTriggerDefinition | TriggerDefinition | |||||||
valueUsageContext | UsageContext | |||||||
valueDosage | Dosage | |||||||
valueMeta | Meta | |||||||
input:SmartClientId | S | 1..1 | BackboneElement | SMART App Client ID | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | S | 1..1 | CodeableConcept | Label for the input Binding: Specialty Rx Value Set - Task Input Type (required): This value set contains Task.input types used in the Specialty Rx Task profiles Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: smart-app-client-id | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: SMART Application Client ID | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | S | 1..1 | Identifier | SMART App Client ID | ||||
input:SmartLaunchUrl | S | 0..1 | BackboneElement | Smart App Launch URL | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | S | 1..1 | CodeableConcept | Label for the input Binding: Specialty Rx Value Set - Task Input Type (required): This value set contains Task.input types used in the Specialty Rx Task profiles Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-task-characteristic | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: smart-app-launch-url | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: SMART Application Launch URL | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
value[x] | S | 1..1 | url | SMART launch URL | ||||
output | 0..* | BackboneElement | Information produced as part of task | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding: (unbound) (example): 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. | |||||
value[x] | 1..1 | Result of output | ||||||
valueBase64Binary | base64Binary | |||||||
valueBoolean | boolean | |||||||
valueCanonical | canonical(Any) | |||||||
valueCode | code | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
valueId | id | |||||||
valueInstant | instant | |||||||
valueInteger | integer | |||||||
valueMarkdown | markdown | |||||||
valueOid | oid | |||||||
valuePositiveInt | positiveInt | |||||||
valueString | string | |||||||
valueTime | time | |||||||
valueUnsignedInt | unsignedInt | |||||||
valueUri | uri | |||||||
valueUrl | url | |||||||
valueUuid | uuid | |||||||
valueAddress | Address | |||||||
valueAge | Age | |||||||
valueAnnotation | Annotation | |||||||
valueAttachment | Attachment | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueCoding | Coding | |||||||
valueContactPoint | ContactPoint | |||||||
valueCount | Count | |||||||
valueDistance | Distance | |||||||
valueDuration | Duration | |||||||
valueHumanName | HumanName | |||||||
valueIdentifier | Identifier | |||||||
valueMoney | Money | |||||||
valuePeriod | Period | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueReference | Reference(Any) | |||||||
valueSampledData | SampledData | |||||||
valueSignature | Signature | |||||||
valueTiming | Timing | |||||||
valueContactDetail | ContactDetail | |||||||
valueContributor | Contributor | |||||||
valueDataRequirement | DataRequirement | |||||||
valueExpression | Expression | |||||||
valueParameterDefinition | ParameterDefinition | |||||||
valueRelatedArtifact | RelatedArtifact | |||||||
valueTriggerDefinition | TriggerDefinition | |||||||
valueUsageContext | UsageContext | |||||||
valueDosage | Dosage | |||||||
valueMeta | Meta | |||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Task.language | preferred | CommonLanguages
| ||||
Task.identifier:appContext.use | required | IdentifierUse | ||||
Task.identifier:appContext.type | extensible | Identifier Type Codes | ||||
Task.status | required | TaskStatus | ||||
Task.statusReason | example | |||||
Task.businessStatus | example | |||||
Task.intent | required | Fixed Value: plan | ||||
Task.priority | required | RequestPriority | ||||
Task.code | required | Pattern: complete-app-questionnaire("Complete Questionnaire in SMART App") | ||||
Task.requester.type | extensible | ResourceType | ||||
Task.requester.identifier:pharmacyNcpdpId.use | required | IdentifierUse | ||||
Task.requester.identifier:pharmacyNcpdpId.type | extensible | Identifier Type Codes | ||||
Task.requester.identifier:NPI.use | required | IdentifierUse | ||||
Task.requester.identifier:NPI.type | extensible | Identifier Type Codes | ||||
Task.performerType | preferred | ProcedurePerformerRoleCodes | ||||
Task.owner.type | extensible | ResourceType | ||||
Task.owner.identifier.use | required | IdentifierUse | ||||
Task.owner.identifier.type | extensible | Identifier Type Codes | ||||
Task.reasonCode | example | |||||
Task.reasonReference.type | extensible | ResourceType | ||||
Task.reasonReference.identifier.use | required | IdentifierUse | ||||
Task.reasonReference.identifier.type | extensible | Identifier Type Codes | ||||
Task.input.type | example | |||||
Task.input:SmartClientId.type | required | Pattern: smart-app-client-id("SMART Application Client ID") | ||||
Task.input:SmartLaunchUrl.type | required | Pattern: smart-app-launch-url("SMART Application Launch URL") | ||||
Task.output.type | example |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
srx-1 | warning | Task.reasonReference | 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() | |
srx-2 | error | Task.requester | Either requester.reference or requester.identifier SHALL be present : reference.exists() or identifier.exists() | |
srx-3 | error | Task.owner | Either owner.reference or owner.identifier SHALL be present : reference.exists() or identifier.exists() |