Profile: GPConnect-Task-1
| GPConnect-Task-1 (Task) | C | Task | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | C | 0..1 | Narrative |
| contained | 0..* | Resource | |
| extension | 0..* | Extension | |
| modifierExtension | ?! | 0..* | Extension |
| identifier | 0..* | Identifier | |
| definition[x] | Σ | 0..1 | |
| definitionUri | uri | ||
| definitionReference | Reference(ActivityDefinition) | ||
| basedOn | Σ | 0..* | Reference(Resource | GPConnect-Task-1) |
| groupIdentifier | Σ | 0..1 | Identifier |
| partOf | Σ | 0..* | Reference(Task | GPConnect-Task-1) |
| status | Σ | 1..1 | codeBinding |
| statusReason | Σ | 0..1 | CodeableConcept |
| businessStatus | Σ | 0..1 | CodeableConcept |
| intent | Σ | 1..1 | codeBinding |
| priority | 0..1 | codeBinding | |
| code | Σ | 0..1 | CodeableConcept |
| description | Σ | 0..1 | string |
| focus | Σ | 0..1 | Reference(Resource | GPConnect-Task-1) |
| for | Σ | 0..1 | Reference(Resource | GPConnect-Task-1) |
| context | Σ | 0..1 | Reference(CareConnect-Encounter-1 | EpisodeOfCare) |
| executionPeriod | Σ | 0..1 | Period |
| authoredOn | C | 0..1 | dateTime |
| lastModified | Σ C | 0..1 | dateTime |
| requester | Σ | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | 0..* | Extension | |
| modifierExtension | Σ ?! | 0..* | Extension |
| agent | Σ | 1..1 | Reference(ITK-Device-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | RelatedPerson) |
| id | 0..1 | string | |
| extension | 0..* | Extension | |
| reference | Σ C | 1..1 | string |
| identifier | Σ | 0..1 | Identifier |
| display | Σ | 0..1 | string |
| onBehalfOf | 0..1 | Reference(Organization) | |
| performerType | 0..* | CodeableConceptBinding | |
| owner | Σ | 0..1 | Reference(ITK-Device-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | RelatedPerson) |
| reason | 0..1 | CodeableConcept | |
| note | 0..* | Annotation | |
| relevantHistory | 0..* | Reference(Provenance) | |
| restriction | 0..1 | BackboneElement | |
| id | 0..1 | string | |
| extension | 0..* | Extension | |
| modifierExtension | Σ ?! | 0..* | Extension |
| repetitions | 0..1 | positiveInt | |
| period | 0..1 | Period | |
| recipient | 0..* | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | RelatedPerson | Group | CareConnect-Organization-1) | |
| input | 1..* | BackboneElement | |
| id | 0..1 | string | |
| extension | 0..* | Extension | |
| modifierExtension | Σ ?! | 0..* | Extension |
| type | 1..1 | CodeableConcept | |
| value[x] | 1..1 | ||
| valueBase64Binary | base64Binary | ||
| valueBoolean | boolean | ||
| 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 | ||
| 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 | ||
| valueSampledData | SampledData | ||
| valueSignature | Signature | ||
| valueTiming | Timing | ||
| valueMeta | Meta | ||
| valueReference | Reference( | GPConnect-Task-1) | ||
| output | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | 0..* | Extension | |
| modifierExtension | Σ ?! | 0..* | Extension |
| type | 1..1 | CodeableConcept | |
| value[x] | 1..1 | ||
| valueBase64Binary | base64Binary | ||
| valueBoolean | boolean | ||
| 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 | ||
| 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 | ||
| valueSampledData | SampledData | ||
| valueSignature | Signature | ||
| valueTiming | Timing | ||
| valueMeta | Meta | ||
| valueReference | Reference() |
| Task | |||
| Short | A task to be performed | ||
| Definition | A task to be performed. | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.id | |||
| Short | Logical id of this artifact | ||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
| Cardinality | 0..1 | ||
| Type | id | ||
| Summary | True | ||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| Task.meta | |||
| Short | Metadata about the resource | ||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Task.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Modifier | True | ||
| Summary | True | ||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
| Task.language | |||
| Short | Language of the resource content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language. Binding extensions
| ||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
| Task.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||
| Cardinality | 0..1 | ||
| Type | Narrative | ||
| Alias | narrative, html, xhtml, display | ||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-1 | ||
| Mappings |
| ||
| Task.contained | |||
| Short | Contained, inline Resources | ||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
| Cardinality | 0..* | ||
| Type | Resource | ||
| Alias | inline resources, anonymous resources, contained resources | ||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||
| Mappings |
| ||
| Task.extension | |||
| Short | Additional Content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Mappings |
| ||
| Task.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Mappings |
| ||
| Task.identifier | |||
| Short | Task Instance Identifier | ||
| Definition | The business identifier for this task. | ||
| Cardinality | 0..* | ||
| Type | Identifier | ||
| Mappings |
| ||
| Task.definition[x] | |||
| Short | Formal definition of task | ||
| Definition | A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc. | ||
| Cardinality | 0..1 | ||
| Type | Reference(ActivityDefinition), uri | ||
| Summary | True | ||
| Requirements | Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation) to be associated with a task, enabling automation. | ||
| Mappings |
| ||
| Task.basedOn | |||
| Short | Request fulfilled by this task | ||
| Definition | BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient. | ||
| Cardinality | 0..* | ||
| Type | Reference(Resource | GPConnect-Task-1) | ||
| Summary | True | ||
| Mappings |
| ||
| Task.groupIdentifier | |||
| Short | Requisition or grouper id | ||
| Definition | An identifier that links together multiple tasks and other requests that were created in the same context. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Requirements | Billing and/or reporting can be linked to whether multiple requests were created as a single unit. | ||
| Mappings |
| ||
| Task.partOf | |||
| Short | Composite task | ||
| Definition | Task that this particular task is part of. | ||
| Cardinality | 0..* | ||
| Type | Reference(Task | GPConnect-Task-1) | ||
| Summary | True | ||
| Requirements | Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task). | ||
| Comments | This should usually be 0..1. | ||
| Mappings |
| ||
| Task.status | |||
| Short | draft | requested | received | accepted | + | ||
| Definition | The current status of the task. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The current status of the task. | ||
| Summary | True | ||
| Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. | ||
| Mappings |
| ||
| Task.statusReason | |||
| Short | Reason for current status | ||
| Definition | An explanation as to why this task is held, failed, was refused, etc. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||
| Summary | True | ||
| Comments | This applies to the current status. Look at the history of the task to see reasons for past statuses. | ||
| Mappings |
| ||
| Task.businessStatus | |||
| Short | E.g. "Specimen collected", "IV prepped" | ||
| Definition | Contains business-specific nuances of the business state. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||
| Summary | True | ||
| Requirements | There's often a need to track substates of a task - this is often variable by specific workflow implementation. | ||
| Mappings |
| ||
| Task.intent | |||
| Short | proposal | plan | order + | ||
| Definition | Indicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | Distinguishes whether the task is a proposal, plan or full order | ||
| Summary | True | ||
| Comments | This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order". | ||
| Mappings |
| ||
| Task.priority | |||
| Short | normal | urgent | asap | stat | ||
| Definition | Indicates how quickly the Task should be addressed with respect to other requests. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | The task's priority | ||
| Requirements | Used to identify the service level expected while performing a task. | ||
| Meaning when missing | If missing, this task should be performed with normal priority | ||
| Mappings |
| ||
| Task.code | |||
| Short | Task Type | ||
| Definition | A name or code (or both) briefly describing what the task involves. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | Codes to identify what the task involves. These will typically be specific to a particular workflow. | ||
| Summary | True | ||
| Comments | The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. | ||
| Mappings |
| ||
| Task.description | |||
| Short | Human-readable explanation of task | ||
| Definition | A free-text description of what is to be performed. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Mappings |
| ||
| Task.focus | |||
| Short | What task is acting on | ||
| Definition | The request being actioned or the resource being manipulated by this task. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Resource | GPConnect-Task-1) | ||
| Summary | True | ||
| Requirements | Used to identify the thing to be done. | ||
| Comments | If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.). | ||
| Mappings |
| ||
| Task.for | |||
| Short | Beneficiary of the Task | ||
| Definition | The entity who benefits from the performance of the service specified in the task (e.g., the patient). | ||
| Cardinality | 0..1 | ||
| Type | Reference(Resource | GPConnect-Task-1) | ||
| Summary | True | ||
| Alias | Patient | ||
| Requirements | Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control. | ||
| Mappings |
| ||
| Task.context | |||
| Short | Healthcare event during which this task originated | ||
| Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. | ||
| Cardinality | 0..1 | ||
| Type | Reference(CareConnect-Encounter-1 | EpisodeOfCare) | ||
| Summary | True | ||
| Requirements | For some tasks it may be important to know the link between the task or episode of care the task originated within. | ||
| Mappings |
| ||
| Task.executionPeriod | |||
| Short | Start and end time of execution | ||
| Definition | Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end). | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Mappings |
| ||
| Task.authoredOn | |||
| Short | Task Creation Date | ||
| Definition | The date and time this task was created. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | ||
| Alias | Created Date | ||
| Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 | ||
| Mappings |
| ||
| Task.lastModified | |||
| Short | Task Last Modified Date | ||
| Definition | The date and time of last modification to this task. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | ||
| Summary | True | ||
| Alias | Update Date | ||
| Requirements | Used along with history to track task activity and time in a particular task state. This enables monitoring and management. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 | ||
| Mappings |
| ||
| Task.requester | |||
| Short | Who is asking for task to be done | ||
| Definition | The creator of the task. | ||
| Cardinality | 1..1 | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Requirements | Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task). | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.requester.id | |||
| Short | xml:id (or equivalent in JSON) | ||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.requester.extension | |||
| Short | Additional Content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Mappings |
| ||
| Task.requester.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Mappings |
| ||
| Task.requester.agent | |||
| Short | Individual asking for task | ||
| Definition | The device, practitioner, etc. who initiated the task. | ||
| Cardinality | 1..1 | ||
| Type | Reference(ITK-Device-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | RelatedPerson) | ||
| Summary | True | ||
| Alias | Initiator, Author | ||
| Mappings |
| ||
| Task.requester.agent.id | |||
| Short | xml:id (or equivalent in JSON) | ||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.requester.agent.extension | |||
| Short | Additional Content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Mappings |
| ||
| Task.requester.agent.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-1 | ||
| Mappings |
| ||
| Task.requester.agent.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||
| Mappings |
| ||
| Task.requester.agent.display | |||
| Short | Text alternative for the resource | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||
| Mappings |
| ||
| Task.requester.onBehalfOf | |||
| Short | Organization individual is acting for | ||
| Definition | The organization the device or practitioner was acting on behalf of when they initiated the task. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. | ||
| Mappings |
| ||
| Task.performerType | |||
| Short | requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer | ||
| Definition | The type of participant that can execute the task. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | The type(s) of task performers allowed | ||
| Requirements | Use to distinguish tasks on different activity queues. | ||
| Mappings |
| ||
| Task.owner | |||
| Short | Responsible individual | ||
| Definition | Individual organization or Device currently responsible for task execution. | ||
| Cardinality | 0..1 | ||
| Type | Reference(ITK-Device-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | RelatedPerson) | ||
| Summary | True | ||
| Alias | Performer, Executer | ||
| Requirements | Identifies who is expected to perform this task. | ||
| Comments | Tasks may be created with an owner not yet identified. | ||
| Mappings |
| ||
| Task.reason | |||
| Short | Why task is needed | ||
| Definition | A description or code indicating why this task needs to be performed. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | ||
| Comments | This should only be included if there is no focus or if it differs from the reason indicated on the focus. | ||
| Mappings |
| ||
| Task.note | |||
| Short | Comments made about the task | ||
| Definition | Free-text information captured about the task as it progresses. | ||
| Cardinality | 0..* | ||
| Type | Annotation | ||
| Mappings |
| ||
| Task.relevantHistory | |||
| Short | Key events in history of the Task | ||
| Definition | Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task. | ||
| Cardinality | 0..* | ||
| Type | Reference(Provenance) | ||
| Alias | Status History | ||
| Comments | This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. | ||
| Mappings |
| ||
| Task.restriction | |||
| Short | Constraints on fulfillment tasks | ||
| Definition | If the Task.focus is a request resource and the task is seeking fulfillment (i.e is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Requirements | Sometimes when fulfillment is sought, you don't want full fulfillment. | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.restriction.id | |||
| Short | xml:id (or equivalent in JSON) | ||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.restriction.extension | |||
| Short | Additional Content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Mappings |
| ||
| Task.restriction.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Mappings |
| ||
| Task.restriction.repetitions | |||
| Short | How many times to repeat | ||
| Definition | Indicates the number of times the requested action should occur. | ||
| Cardinality | 0..1 | ||
| Type | positiveInt | ||
| Requirements | E.g. order that requests monthly lab tests, fulfillment is sought for 1. | ||
| Mappings |
| ||
| Task.restriction.period | |||
| Short | When fulfillment sought | ||
| Definition | Over what time-period is fulfillment sought. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Requirements | E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months. | ||
| Comments | Note that period.high is the due date representing the time by which the task should be completed. | ||
| Mappings |
| ||
| Task.restriction.recipient | |||
| Short | For whom is fulfillment sought? | ||
| Definition | For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought? | ||
| Cardinality | 0..* | ||
| Type | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | RelatedPerson | Group | CareConnect-Organization-1) | ||
| Mappings |
| ||
| Task.input | |||
| Short | Information used to perform task | ||
| Definition | Additional information that may be needed in the execution of the task. | ||
| Cardinality | 1..* | ||
| Type | BackboneElement | ||
| Alias | Supporting Information | ||
| Requirements | Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows. | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.input.id | |||
| Short | xml:id (or equivalent in JSON) | ||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.input.extension | |||
| Short | Additional Content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Mappings |
| ||
| Task.input.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Mappings |
| ||
| Task.input.type | |||
| Short | Label for the input | ||
| Definition | A code or description indicating how the input is intended to be used as part of the task execution. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concommitent Medications", etc. | ||
| Alias | Name | ||
| Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next. | ||
| Comments | If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input. | ||
| Mappings |
| ||
| Task.input.value[x] | |||
| Short | Content to use in performing the task | ||
| Definition | The value of the input parameter as a basic type. | ||
| Cardinality | 1..1 | ||
| Type | Reference( | GPConnect-Task-1), base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, SampledData, Signature, Timing, Meta | ||
| Mappings |
| ||
| Task.output | |||
| Short | Information produced as part of task | ||
| Definition | Outputs produced by the Task. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Requirements | Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows. | ||
| Constraints |
| ||
| Mappings |
| ||
| Task.output.id | |||
| Short | xml:id (or equivalent in JSON) | ||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Task.output.extension | |||
| Short | Additional Content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Mappings |
| ||
| Task.output.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Mappings |
| ||
| Task.output.type | |||
| Short | Label for output | ||
| Definition | The name of the Output parameter. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc. | ||
| Alias | Name | ||
| Requirements | Outputs are named to enable task automation to bind data and pass it from one task to the next. | ||
| Mappings |
| ||
| Task.output.value[x] | |||
| Short | Result of output | ||
| Definition | The value of the Output parameter as a basic type. | ||
| Cardinality | 1..1 | ||
| Type | Reference(), base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, SampledData, Signature, Timing, Meta | ||
| Requirements | Task outputs can take any form. | ||
| Mappings |
| ||
Data model element usage
| Element | Use | CareConnect (STU3) | UK Core (R4) |
|---|---|---|---|
| identifier | |||
| definition | |||
| basedOn | |||
| groupIdentifier | |||
| partOf | |||
| status | |||
| statusReason | |||
| businessStatus | |||
| intent | |||
| priority | |||
| Code | |||
| description | |||
| focus | |||
| for | |||
| context | |||
| executionPeriod | |||
| authoredOn | |||
| lastModified | |||
| requester | |||
| performerType | |||
| owner | |||
| reason | |||
| note | |||
| relevantHistory | |||
| restriction | |||
| input | |||
| output |
identifier
Usage
Required
Guidance
The business identifier for this task.
Example
</text> <identifier> <use value="official"/> <system value="http:/goodhealth.org/identifiers"/> <value value="20240201-001"/> </identifier>
definition
basedOn
Usage
Optional
Guidance
Indicates any plans or prior referrals that this referral is intended to fulfill.
Example
<basedOn> <reference value="careplan--procedure-request--referral-request--00123f72" /> </basedOn>
groupIdentifier
Usage
Optional
Guidance
Used to link other tasks, and requests, that were created together in the same context.
Example
<groupIdentifier> <use value="official"/> <system value="http:/goodhealth.org/accession/identifiers"/> <value value="G20170201-001"/> </groupIdentifier>
partOf
Usage
Optional
Guidance
Indicates if this task is part of another task.
Example
<partOf> <reference value="Task/example1"/> <display value="Lipid Panel"/> </partOf>
status
Usage
Mandatory
Guidance
The current status of the task.
Example
<status value="completed"/>
statusReason
Usage
Required
Guidance
An explanation for current status of the task.
Example
businessStatus
Usage
Required
Guidance
A progress update for the task, in relation to business specific nuances.
Example
<businessStatus> <text value="specimen received, test in progress"/> </businessStatus>
intent
Usage
Mandatory
Guidance
The intent element is a mandatory one within FHIR and while it can be populated with any value from the available code system, it is expected that must use-cases within GP Connect will be order.
Example
<intent value="order" />
priority
Usage
Required
Guidance
Indicates the urgency of the task and how quickly it should be addressed.
Example
<priority value="routine"/>
code
Usage
Required
Guidance
The name or code (or both) to briefly describe the task.
Example
<code> <text value="Specimen Collection"/> </code>
description
Usage
Required
Guidance
Free-text description of what is to be performed as part of the task.
Example
<description value="Create order for getting specimen, Set up inhouse testing, generate order for any sendouts and submit with specimen"/>
focus
Usage
Optional
Guidance
A reference to a request which is being actioned by this task.
Example
<focus> <reference value="ProcedureRequest/lipid"/> <display value="Lipid Panel Request"/> </focus>
for
Usage
Mandatory
Guidance
A reference to the person/organization etc who benefits from the task being performed (e.g. the patient)
Example
<for> <reference value="Patient/example"/> <display value="Peter James Chalmers"/> </for>
context
Usage
Optional
Guidance
The healthcare event, appointment, encounter etc where the task originated.
Example
<context> <reference value="Encounter/example"/> <display value="Example GP Appointment"/> </context>
executionPeriod
Usage
Optional
Guidance
The time when the first action was performed against the task (start) and/or the final action time (end).
Example
<executionPeriod> <start value="2024-10-31T08:25:05+00:00"/> </executionPeriod>
lastModified
Usage
Required
Guidance
The date and time this task was most recently modified.
Example
<lastModified value="2024-10-2T08:25:05+00:00"/>
requester
Usage
Mandatory
Guidance
Who created the task. This element can include references to other resources to show both the requester.agent (this could be a patient, practitioner, organization etc) and requester.onBehalfOf (the organization) but only the requester.agent is mandatory
Example
<requester> <agent> <reference value="Practitioner/example"/> <display value="Dr Adam Careful"/> </agent> <onBehalfOf> <reference value="Organization/2.16.840.1.113883.19.5"/> <display value="Good Health Clinic"/> </onBehalfOf> </requester>
performerType
Usage
Optional
Guidance
The type of particpant that can execute the task.
Example
<performerType> <coding> <system value="http://hl7.org/fhir/task-performer-type"/> <code value="performer"/> <display value="Performer"/> </coding> <text value="Performer"/> </performerType>
owner
Usage
Mandatory
Guidance
The person, organization, or device, that is responsible for carrying out the task.
Example
<owner> <reference value="Organization/1832473e-2fe0-452d-abe9-3cdb9879522f"/> <display value="Clinical Laboratory @ AcmeHospital"/> </owner>
reason
Usage
Required
Guidance
Text description, or code, to indicate why this task needs to be performed.
Note: This element should only be included if task.focus is either not provided or contains different information.
Example
<lastModified value="2024-10-2T08:25:05+00:00"/>
note
Usage
Optional
Guidance
Free-text information/comments relevant to the task.
Example
<note> <text value="This is an example to demonstrate using task.note for adding a comment regarding a task."/> </note>
relevantHistory
Usage
Optional
Guidance
Reference(s) to Provenance records for historic versions of the task, to identify updates that may be relevant to the current version.
Example
<note> <text value="This is an example to demonstrate using task.note for adding a comment regarding a task."/> </note>
restriction
Usage
Required
Guidance
Any constraints or limitations on the task, such as how many times it should occur.
Note: Only applicable where the task.focus is a "request resource"
Example
<restriction> <repetitions value="1"/> <period> <end value="2016-11-02T09:45:05+10:00"/> </period> </restriction>
input
Usage
Optional
Guidance
Additional information relating to the task
Example
output
Usage
Optional
Guidance
Outputs, and links to references, that have been produced by the task.
Example
</output> <output> <type> <text value="collected specimen"/> </type> <valueReference> <reference value="Specimen/101"/> </valueReference> </output>