WHO-UMC IDMP Management and Publish API, published by Uppsala Monitoring Centre. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Uppsala-Monitoring-Centre/WHO-UMC-IDMP-Service/ and changes regularly. See the Directory of published versions
Official URL: http://who-umc.org/idmp/StructureDefinition/Task-who-php-gsid | Version: 0.1.0 | |||
Active as of 2024-11-11 | Computable Name: TaskGenerateGSID |
This profile specified how to use the Task resource to request (via POST) the generation of a GSID by using the WHO-UMC IDMP FHIR Service
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 | |
contained | 1..1 | Resource | SubstanceDefinition resource to request GSID for. | |
identifier | 1..* | Identifier | Identifier assigned by the requestor to track the request. | |
instantiatesUri | 0..1 | uri | Link to the definiton of the task | |
status | 1..1 | code | Status of the task should always be 'requested' when a new request Required Pattern: requested | |
businessStatus | 0..1 | CodeableConcept | business-specific state | |
intent | 1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: proposal | |
priority | 0..1 | code | Task priority | |
code | 0..1 | CodeableConcept | GSID Assignment | |
encounter | 0..1 | Reference(Encounter) | Not used in this profile | |
authoredOn | 1..1 | dateTime | Task Creation Date | |
lastModified | 1..1 | dateTime | Task Last Modified Date | |
requester | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Not used in this profile | |
insurance | 0..* | Reference(Coverage | ClaimResponse) | Not used in this profile | |
restriction | 0..1 | BackboneElement | Not used in this profile | |
input | 1..1 | BackboneElement | Information used to perform task | |
type | 1..1 | CodeableConcept | Label for the input 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://who-umc.org/idmp/CodeSystem/task-input-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: substance-request-resource | |
value[x] | 1..1 | Reference(SubstanceDefinition for request) | Content to use in performing the task | |
output | 0..1 | BackboneElement | Information produced as part of task | |
type | 1..1 | CodeableConcept | Label for output 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/fhir-types | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SubstanceDefinition | |
value[x] | 1..1 | Reference(SubstanceDefinition for publication) | Result of output | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. tsk-1: Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified. |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 1..1 | Resource | SubstanceDefinition resource to request GSID for. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | 1..* | Identifier | Identifier assigned by the requestor to track the request. | |
instantiatesUri | Σ | 0..1 | uri | Link to the definiton of the task |
status | ?!Σ | 1..1 | code | Status of the task should always be 'requested' when a new request Binding: TaskStatus (required): The current status of the task. Required Pattern: requested |
businessStatus | Σ | 0..1 | CodeableConcept | business-specific state Binding Description (No ValueSet): (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. |
intent | Σ | 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. Required Pattern: proposal |
priority | 0..1 | code | Task priority Binding: RequestPriority (required): The priority of a task (may affect service level applied to the task). | |
doNotPerform | ?!Σ | 0..1 | boolean | True if Task is prohibiting action |
code | ΣC | 0..1 | CodeableConcept | GSID Assignment Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. |
encounter | Σ | 0..1 | Reference(Encounter) | Not used in this profile |
authoredOn | C | 1..1 | dateTime | Task Creation Date |
lastModified | ΣC | 1..1 | dateTime | Task Last Modified Date |
requester | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Not used in this profile |
insurance | 0..* | Reference(Coverage | ClaimResponse) | Not used in this profile | |
restriction | C | 0..1 | BackboneElement | Not used in this profile |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
input | 1..1 | BackboneElement | Information used to perform task | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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. 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://who-umc.org/idmp/CodeSystem/task-input-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: substance-request-resource | |
value[x] | 1..1 | Reference(SubstanceDefinition for request) | Content to use in performing the task | |
output | 0..1 | BackboneElement | Information produced as part of task | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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. 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/fhir-types | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SubstanceDefinition | |
value[x] | 1..1 | Reference(SubstanceDefinition for publication) | Result of output | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Task.status | required | Pattern: requestedhttp://hl7.org/fhir/ValueSet/task-status|5.0.0 from the FHIR Standard | |
Task.businessStatus | example | ||
Task.intent | required | Pattern: proposalhttp://hl7.org/fhir/ValueSet/task-intent|5.0.0 from the FHIR Standard | |
Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|5.0.0 from the FHIR Standard | |
Task.code | example | TaskCodehttp://hl7.org/fhir/ValueSet/task-code from the FHIR Standard | |
Task.input.type | example | Pattern: substance-request-resource | |
Task.output.type | example | Pattern: SubstanceDefinition |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | |
tsk-1 | error | Task | Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified. : restriction.exists() implies code.coding.where(code='fulfill' and system='http://hl7.org/fhir/CodeSystem/task-code').exists() and focus.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. tsk-1: Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified. | ||||
id | Σ | 0..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: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 1..1 | Resource | SubstanceDefinition resource to request GSID for. | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 1..* | Identifier | Identifier assigned by the requestor to track the request. | |||||
instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
instantiatesUri | Σ | 0..1 | uri | Link to the definiton of the 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 | Status of the task should always be 'requested' when a new request Binding: TaskStatus (required): The current status of the task. Required Pattern: requested | ||||
statusReason | Σ | 0..1 | CodeableReference() | Reason for current status Binding: TaskStatusReason (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
businessStatus | Σ | 0..1 | CodeableConcept | business-specific state Binding Description (No ValueSet): (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
intent | Σ | 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. Required Pattern: proposal | ||||
priority | 0..1 | code | Task priority Binding: RequestPriority (required): The priority of a task (may affect service level applied to the task). | |||||
doNotPerform | ?!Σ | 0..1 | boolean | True if Task is prohibiting action | ||||
code | ΣC | 0..1 | CodeableConcept | GSID Assignment Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. | ||||
description | Σ | 0..1 | string | Human-readable explanation of task | ||||
focus | ΣC | 0..1 | Reference(Resource) | What task is acting on | ||||
for | Σ | 0..1 | Reference(Resource) | Beneficiary of the Task | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Not used in this profile | ||||
requestedPeriod | Σ | 0..1 | Period | When the task should be performed | ||||
executionPeriod | Σ | 0..1 | Period | Start and end time of execution | ||||
authoredOn | C | 1..1 | dateTime | Task Creation Date | ||||
lastModified | ΣC | 1..1 | dateTime | Task Last Modified Date | ||||
requester | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Not used in this profile | ||||
requestedPerformer | 0..* | CodeableReference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Who should perform Task Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
owner | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Responsible individual | ||||
performer | Σ | 0..* | BackboneElement | Who or what performed the 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 | ||||
function | Σ | 0..1 | CodeableConcept | Type of performance Binding Description (No ValueSet): (example): Codes to identify types of task performers. | ||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who performed the task | ||||
location | Σ | 0..1 | Reference(Location) | Where task occurs | ||||
reason | 0..* | CodeableReference() | Why task is needed Binding Description (No ValueSet): (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Not used in this profile | |||||
note | 0..* | Annotation | Comments made about the task | |||||
relevantHistory | 0..* | Reference(Provenance) | Key events in history of the Task | |||||
restriction | C | 0..1 | BackboneElement | Not used in this profile | ||||
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 is sought | |||||
recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
input | 1..1 | BackboneElement | Information used to perform 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 the input Binding Description (No ValueSet): (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. 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://who-umc.org/idmp/CodeSystem/task-input-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: substance-request-resource | |||||
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 | |||||
value[x] | 1..1 | Reference(SubstanceDefinition for request) | Content to use in performing the task | |||||
output | 0..1 | 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 Description (No ValueSet): (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. 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/fhir-types | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SubstanceDefinition | |||||
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 | |||||
value[x] | 1..1 | Reference(SubstanceDefinition for publication) | Result of output | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Task.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Task.status | required | Pattern: requestedhttp://hl7.org/fhir/ValueSet/task-status|5.0.0 from the FHIR Standard | |
Task.statusReason | example | TaskStatusReasonhttp://hl7.org/fhir/ValueSet/task-status-reason from the FHIR Standard | |
Task.businessStatus | example | ||
Task.intent | required | Pattern: proposalhttp://hl7.org/fhir/ValueSet/task-intent|5.0.0 from the FHIR Standard | |
Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|5.0.0 from the FHIR Standard | |
Task.code | example | TaskCodehttp://hl7.org/fhir/ValueSet/task-code from the FHIR Standard | |
Task.requestedPerformer | preferred | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role from the FHIR Standard | |
Task.performer.function | example | ||
Task.reason | example | ||
Task.input.type | example | Pattern: substance-request-resource | |
Task.output.type | example | Pattern: SubstanceDefinition |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | |
tsk-1 | error | Task | Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified. : restriction.exists() implies code.coding.where(code='fulfill' and system='http://hl7.org/fhir/CodeSystem/task-code').exists() and focus.exists() |
This structure is derived from Task
Differential View
This structure is derived from Task
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | 0..* | Task | A task to be performed | |
contained | 1..1 | Resource | SubstanceDefinition resource to request GSID for. | |
identifier | 1..* | Identifier | Identifier assigned by the requestor to track the request. | |
instantiatesUri | 0..1 | uri | Link to the definiton of the task | |
status | 1..1 | code | Status of the task should always be 'requested' when a new request Required Pattern: requested | |
businessStatus | 0..1 | CodeableConcept | business-specific state | |
intent | 1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: proposal | |
priority | 0..1 | code | Task priority | |
code | 0..1 | CodeableConcept | GSID Assignment | |
encounter | 0..1 | Reference(Encounter) | Not used in this profile | |
authoredOn | 1..1 | dateTime | Task Creation Date | |
lastModified | 1..1 | dateTime | Task Last Modified Date | |
requester | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Not used in this profile | |
insurance | 0..* | Reference(Coverage | ClaimResponse) | Not used in this profile | |
restriction | 0..1 | BackboneElement | Not used in this profile | |
input | 1..1 | BackboneElement | Information used to perform task | |
type | 1..1 | CodeableConcept | Label for the input 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://who-umc.org/idmp/CodeSystem/task-input-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: substance-request-resource | |
value[x] | 1..1 | Reference(SubstanceDefinition for request) | Content to use in performing the task | |
output | 0..1 | BackboneElement | Information produced as part of task | |
type | 1..1 | CodeableConcept | Label for output 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/fhir-types | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SubstanceDefinition | |
value[x] | 1..1 | Reference(SubstanceDefinition for publication) | Result of output | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. tsk-1: Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified. |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 1..1 | Resource | SubstanceDefinition resource to request GSID for. | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | 1..* | Identifier | Identifier assigned by the requestor to track the request. | |
instantiatesUri | Σ | 0..1 | uri | Link to the definiton of the task |
status | ?!Σ | 1..1 | code | Status of the task should always be 'requested' when a new request Binding: TaskStatus (required): The current status of the task. Required Pattern: requested |
businessStatus | Σ | 0..1 | CodeableConcept | business-specific state Binding Description (No ValueSet): (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. |
intent | Σ | 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. Required Pattern: proposal |
priority | 0..1 | code | Task priority Binding: RequestPriority (required): The priority of a task (may affect service level applied to the task). | |
doNotPerform | ?!Σ | 0..1 | boolean | True if Task is prohibiting action |
code | ΣC | 0..1 | CodeableConcept | GSID Assignment Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. |
encounter | Σ | 0..1 | Reference(Encounter) | Not used in this profile |
authoredOn | C | 1..1 | dateTime | Task Creation Date |
lastModified | ΣC | 1..1 | dateTime | Task Last Modified Date |
requester | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Not used in this profile |
insurance | 0..* | Reference(Coverage | ClaimResponse) | Not used in this profile | |
restriction | C | 0..1 | BackboneElement | Not used in this profile |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
input | 1..1 | BackboneElement | Information used to perform task | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (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. 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://who-umc.org/idmp/CodeSystem/task-input-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: substance-request-resource | |
value[x] | 1..1 | Reference(SubstanceDefinition for request) | Content to use in performing the task | |
output | 0..1 | BackboneElement | Information produced as part of task | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (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. 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/fhir-types | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SubstanceDefinition | |
value[x] | 1..1 | Reference(SubstanceDefinition for publication) | Result of output | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Task.status | required | Pattern: requestedhttp://hl7.org/fhir/ValueSet/task-status|5.0.0 from the FHIR Standard | |
Task.businessStatus | example | ||
Task.intent | required | Pattern: proposalhttp://hl7.org/fhir/ValueSet/task-intent|5.0.0 from the FHIR Standard | |
Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|5.0.0 from the FHIR Standard | |
Task.code | example | TaskCodehttp://hl7.org/fhir/ValueSet/task-code from the FHIR Standard | |
Task.input.type | example | Pattern: substance-request-resource | |
Task.output.type | example | Pattern: SubstanceDefinition |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | |
tsk-1 | error | Task | Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified. : restriction.exists() implies code.coding.where(code='fulfill' and system='http://hl7.org/fhir/CodeSystem/task-code').exists() and focus.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. tsk-1: Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified. | ||||
id | Σ | 0..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: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 1..1 | Resource | SubstanceDefinition resource to request GSID for. | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 1..* | Identifier | Identifier assigned by the requestor to track the request. | |||||
instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
instantiatesUri | Σ | 0..1 | uri | Link to the definiton of the 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 | Status of the task should always be 'requested' when a new request Binding: TaskStatus (required): The current status of the task. Required Pattern: requested | ||||
statusReason | Σ | 0..1 | CodeableReference() | Reason for current status Binding: TaskStatusReason (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
businessStatus | Σ | 0..1 | CodeableConcept | business-specific state Binding Description (No ValueSet): (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
intent | Σ | 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. Required Pattern: proposal | ||||
priority | 0..1 | code | Task priority Binding: RequestPriority (required): The priority of a task (may affect service level applied to the task). | |||||
doNotPerform | ?!Σ | 0..1 | boolean | True if Task is prohibiting action | ||||
code | ΣC | 0..1 | CodeableConcept | GSID Assignment Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. | ||||
description | Σ | 0..1 | string | Human-readable explanation of task | ||||
focus | ΣC | 0..1 | Reference(Resource) | What task is acting on | ||||
for | Σ | 0..1 | Reference(Resource) | Beneficiary of the Task | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Not used in this profile | ||||
requestedPeriod | Σ | 0..1 | Period | When the task should be performed | ||||
executionPeriod | Σ | 0..1 | Period | Start and end time of execution | ||||
authoredOn | C | 1..1 | dateTime | Task Creation Date | ||||
lastModified | ΣC | 1..1 | dateTime | Task Last Modified Date | ||||
requester | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Not used in this profile | ||||
requestedPerformer | 0..* | CodeableReference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Who should perform Task Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
owner | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Responsible individual | ||||
performer | Σ | 0..* | BackboneElement | Who or what performed the 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 | ||||
function | Σ | 0..1 | CodeableConcept | Type of performance Binding Description (No ValueSet): (example): Codes to identify types of task performers. | ||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who performed the task | ||||
location | Σ | 0..1 | Reference(Location) | Where task occurs | ||||
reason | 0..* | CodeableReference() | Why task is needed Binding Description (No ValueSet): (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Not used in this profile | |||||
note | 0..* | Annotation | Comments made about the task | |||||
relevantHistory | 0..* | Reference(Provenance) | Key events in history of the Task | |||||
restriction | C | 0..1 | BackboneElement | Not used in this profile | ||||
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 is sought | |||||
recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
input | 1..1 | BackboneElement | Information used to perform 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 the input Binding Description (No ValueSet): (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. 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://who-umc.org/idmp/CodeSystem/task-input-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: substance-request-resource | |||||
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 | |||||
value[x] | 1..1 | Reference(SubstanceDefinition for request) | Content to use in performing the task | |||||
output | 0..1 | 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 Description (No ValueSet): (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. 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/fhir-types | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SubstanceDefinition | |||||
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 | |||||
value[x] | 1..1 | Reference(SubstanceDefinition for publication) | Result of output | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Task.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Task.status | required | Pattern: requestedhttp://hl7.org/fhir/ValueSet/task-status|5.0.0 from the FHIR Standard | |
Task.statusReason | example | TaskStatusReasonhttp://hl7.org/fhir/ValueSet/task-status-reason from the FHIR Standard | |
Task.businessStatus | example | ||
Task.intent | required | Pattern: proposalhttp://hl7.org/fhir/ValueSet/task-intent|5.0.0 from the FHIR Standard | |
Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|5.0.0 from the FHIR Standard | |
Task.code | example | TaskCodehttp://hl7.org/fhir/ValueSet/task-code from the FHIR Standard | |
Task.requestedPerformer | preferred | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role from the FHIR Standard | |
Task.performer.function | example | ||
Task.reason | example | ||
Task.input.type | example | Pattern: substance-request-resource | |
Task.output.type | example | Pattern: SubstanceDefinition |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | |
tsk-1 | error | Task | Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified. : restriction.exists() implies code.coding.where(code='fulfill' and system='http://hl7.org/fhir/CodeSystem/task-code').exists() and focus.exists() |
This structure is derived from Task
Other representations of profile: CSV, Excel, Schematron