PrescribeIT® Specification and Guide Version 5.0

 

The official URL for this profile is:

http://prescribeit.ca/fhir/StructureDefinition/task-903

Download Excel representation

Description of Profiles, Differentials, Snapshots and how the different presentations work.

>

This structure is derived from Task

NameCard.TypeConstraints and Usage
.  Task 0..*Taskinv-2: A Failure reason may be present only when a task has failed.
inv-1: Last modified date must be greater than or equal to created date.
Definition:
A task to be performed.

..  id 1..1idDefinition:
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.


Comments:
Usage Note: This will usually be a GUID and is assigned by the sending application.

..  type 1..1Shared Health CodeableConcept CodeBinding: PrescriptionTaskType (20190315) (required)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


...  coding 1..*CodingDefinition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

....  system 1..1uriDefinition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
This is the URI that represents the coding system as defined within the binding.

....  code 1..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
This is the code as defined within the binding.

....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

..  subject 1..1Reference(PrescribeIT® Prescription 903) {b}Definition:
A reference from one resource to another.


Comments:
Identifies the medication order tied to the task. (FHIR prohibits inheritance of context, so this must be explicitly declared rather than inferred from the presence of the Patient resource in the message)

...  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

..  creator 1..1Reference(Shared Health Practitioner - 903) {b}Definition:
The creator of the task.


Comments:
This is who is submitting the task and asking it be done

...  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

..  owner 1..1Reference(Shared Health - eRx Service Location) {b}Definition:
The owner of this task. The participant who can execute this task.


Comments:
This information duplicates what appear in Provenance but is often needs to be more accessible.

...  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
This is a reference to the pharmacy Organization being requested to act. This value will be returned from the Provider Registry query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Organization/{CPRID}'

This structure is derived from Task

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task 0..*TaskA task to be performed
... id S1..1idLogical id of this artifact
... meta
.... security 0..0
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: PrescriptionTaskType (20190315) (required)
.... coding
..... display S0..1stringRepresentation defined by the system
... subject S1..1Reference(PrescribeIT® Prescription 903) {b}Focus of task
.... reference S1..1stringRelative, internal or absolute URL reference
... creator S1..1Reference(Shared Health Practitioner - 903) {b}Task Creator
.... reference S1..1stringRelative, internal or absolute URL reference
... owner S1..1Reference(Shared Health - eRx Service Location) {b}Task Owner
.... reference S1..1stringRelative, internal or absolute URL reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task I0..*TaskA task to be performed
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..1IdentifierTask Instance Identifier
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: PrescriptionTaskType (20190315) (required)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣ1..*CodingCode defined by a terminology system
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system SΣ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
..... display SΣ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... description Σ0..1stringTask Description
... performerType 0..*Codingrequester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer
Binding: TaskPerformerType (preferred): The type(s) of task performers allowed


... priority 0..1codelow | normal | high
Binding: TaskPriority (required): The task's priority

... status ΣI1..1codedraft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.

... failureReason ΣI0..1CodeableConceptTask Failure Reason
... subject S1..1Reference(PrescribeIT® Prescription 903) {b}Focus of task
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... for Σ0..1Reference(Resource)Beneficiary of the Task
... definition Σ0..1uriTask Definition
... created I1..1dateTimeTask Creation Date
... lastModified ΣI1..1dateTimeTask Last Modified Date
... creator S1..1Reference(Shared Health Practitioner - 903) {b}Task Creator
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... owner S1..1Reference(Shared Health - eRx Service Location) {b}Task Owner
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... parent 0..1Reference(Task)Composite task
... input 0..*BackboneElementTask Input
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... name 1..1stringInput Name
.... value[x] 1..1Input Value
..... valueBooleanboolean
..... valueIntegerinteger
..... valueDecimaldecimal
..... valueBase64Binarybase64Binary
..... valueInstantinstant
..... valueStringstring
..... valueUriuri
..... valueDatedate
..... valueDateTimedateTime
..... valueTimetime
..... valueCodecode
..... valueOidoid
..... valueIdid
..... valueUnsignedIntunsignedInt
..... valuePositiveIntpositiveInt
..... valueMarkdownmarkdown
..... valueAnnotationAnnotation
..... valueAttachmentAttachment
..... valueIdentifierIdentifier
..... valueCodeableConceptCodeableConcept
..... valueCodingCoding
..... valueQuantityQuantity
..... valueRangeRange
..... valuePeriodPeriod
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueSignatureSignature
..... valueHumanNameHumanName
..... valueAddressAddress
..... valueContactPointContactPoint
..... valueTimingTiming
..... valueReferenceReference(Any)
..... valueMetaMeta
... output 0..*BackboneElementTask Output
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... name 1..1stringOutput Name
.... value[x] 1..1Output Value
..... valueBooleanboolean
..... valueIntegerinteger
..... valueDecimaldecimal
..... valueBase64Binarybase64Binary
..... valueInstantinstant
..... valueStringstring
..... valueUriuri
..... valueDatedate
..... valueDateTimedateTime
..... valueTimetime
..... valueCodecode
..... valueOidoid
..... valueIdid
..... valueUnsignedIntunsignedInt
..... valuePositiveIntpositiveInt
..... valueMarkdownmarkdown
..... valueAnnotationAnnotation
..... valueAttachmentAttachment
..... valueIdentifierIdentifier
..... valueCodeableConceptCodeableConcept
..... valueCodingCoding
..... valueQuantityQuantity
..... valueRangeRange
..... valuePeriodPeriod
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueSignatureSignature
..... valueHumanNameHumanName
..... valueAddressAddress
..... valueContactPointContactPoint
..... valueTimingTiming
..... valueReferenceReference(Any)
..... valueMetaMeta

doco Documentation for this format

Grid View

This structure is derived from Task

NameCard.TypeConstraints and Usage
.  Task 0..*Taskinv-2: A Failure reason may be present only when a task has failed.
inv-1: Last modified date must be greater than or equal to created date.
Definition:
A task to be performed.

..  id 1..1idDefinition:
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.


Comments:
Usage Note: This will usually be a GUID and is assigned by the sending application.

..  type 1..1Shared Health CodeableConcept CodeBinding: PrescriptionTaskType (20190315) (required)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


...  coding 1..*CodingDefinition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

....  system 1..1uriDefinition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
This is the URI that represents the coding system as defined within the binding.

....  code 1..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
This is the code as defined within the binding.

....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

..  subject 1..1Reference(PrescribeIT® Prescription 903) {b}Definition:
A reference from one resource to another.


Comments:
Identifies the medication order tied to the task. (FHIR prohibits inheritance of context, so this must be explicitly declared rather than inferred from the presence of the Patient resource in the message)

...  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

..  creator 1..1Reference(Shared Health Practitioner - 903) {b}Definition:
The creator of the task.


Comments:
This is who is submitting the task and asking it be done

...  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

..  owner 1..1Reference(Shared Health - eRx Service Location) {b}Definition:
The owner of this task. The participant who can execute this task.


Comments:
This information duplicates what appear in Provenance but is often needs to be more accessible.

...  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
This is a reference to the pharmacy Organization being requested to act. This value will be returned from the Provider Registry query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Organization/{CPRID}'

Differential View

This structure is derived from Task

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task 0..*TaskA task to be performed
... id S1..1idLogical id of this artifact
... meta
.... security 0..0
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: PrescriptionTaskType (20190315) (required)
.... coding
..... display S0..1stringRepresentation defined by the system
... subject S1..1Reference(PrescribeIT® Prescription 903) {b}Focus of task
.... reference S1..1stringRelative, internal or absolute URL reference
... creator S1..1Reference(Shared Health Practitioner - 903) {b}Task Creator
.... reference S1..1stringRelative, internal or absolute URL reference
... owner S1..1Reference(Shared Health - eRx Service Location) {b}Task Owner
.... reference S1..1stringRelative, internal or absolute URL reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task I0..*TaskA task to be performed
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile Σ0..*uriProfiles this resource claims to conform to
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..1IdentifierTask Instance Identifier
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: PrescriptionTaskType (20190315) (required)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣ1..*CodingCode defined by a terminology system
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system SΣ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
..... display SΣ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... description Σ0..1stringTask Description
... performerType 0..*Codingrequester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer
Binding: TaskPerformerType (preferred): The type(s) of task performers allowed


... priority 0..1codelow | normal | high
Binding: TaskPriority (required): The task's priority

... status ΣI1..1codedraft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.

... failureReason ΣI0..1CodeableConceptTask Failure Reason
... subject S1..1Reference(PrescribeIT® Prescription 903) {b}Focus of task
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... for Σ0..1Reference(Resource)Beneficiary of the Task
... definition Σ0..1uriTask Definition
... created I1..1dateTimeTask Creation Date
... lastModified ΣI1..1dateTimeTask Last Modified Date
... creator S1..1Reference(Shared Health Practitioner - 903) {b}Task Creator
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... owner S1..1Reference(Shared Health - eRx Service Location) {b}Task Owner
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... parent 0..1Reference(Task)Composite task
... input 0..*BackboneElementTask Input
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... name 1..1stringInput Name
.... value[x] 1..1Input Value
..... valueBooleanboolean
..... valueIntegerinteger
..... valueDecimaldecimal
..... valueBase64Binarybase64Binary
..... valueInstantinstant
..... valueStringstring
..... valueUriuri
..... valueDatedate
..... valueDateTimedateTime
..... valueTimetime
..... valueCodecode
..... valueOidoid
..... valueIdid
..... valueUnsignedIntunsignedInt
..... valuePositiveIntpositiveInt
..... valueMarkdownmarkdown
..... valueAnnotationAnnotation
..... valueAttachmentAttachment
..... valueIdentifierIdentifier
..... valueCodeableConceptCodeableConcept
..... valueCodingCoding
..... valueQuantityQuantity
..... valueRangeRange
..... valuePeriodPeriod
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueSignatureSignature
..... valueHumanNameHumanName
..... valueAddressAddress
..... valueContactPointContactPoint
..... valueTimingTiming
..... valueReferenceReference(Any)
..... valueMetaMeta
... output 0..*BackboneElementTask Output
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... name 1..1stringOutput Name
.... value[x] 1..1Output Value
..... valueBooleanboolean
..... valueIntegerinteger
..... valueDecimaldecimal
..... valueBase64Binarybase64Binary
..... valueInstantinstant
..... valueStringstring
..... valueUriuri
..... valueDatedate
..... valueDateTimedateTime
..... valueTimetime
..... valueCodecode
..... valueOidoid
..... valueIdid
..... valueUnsignedIntunsignedInt
..... valuePositiveIntpositiveInt
..... valueMarkdownmarkdown
..... valueAnnotationAnnotation
..... valueAttachmentAttachment
..... valueIdentifierIdentifier
..... valueCodeableConceptCodeableConcept
..... valueCodingCoding
..... valueQuantityQuantity
..... valueRangeRange
..... valuePeriodPeriod
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueSignatureSignature
..... valueHumanNameHumanName
..... valueAddressAddress
..... valueContactPointContactPoint
..... valueTimingTiming
..... valueReferenceReference(Any)
..... valueMetaMeta

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Task.meta.tagexample
Task.languagerequiredhttp://tools.ietf.org/html/bcp47
Task.typerequiredPrescriptionTaskType
Task.performerTypepreferredTaskPerformerType
Task.priorityrequiredTaskPriority
Task.statusrequiredTaskStatus

Constraints

IdPathDetailsRequirements
inv-2TaskA Failure reason may be present only when a task has failed.
: failureReason.empty() or status = 'failed'
inv-1TaskLast modified date must be greater than or equal to created date.
: lastModified >= created