ZD Task
Resources conforming to this profile are requested by ZorgDomein during SSO to ZorgDomein to request application context parameters.
Resources conforming to this profile are sent by ZorgDomein to the sender of a transaction when a transaction is cancelled. When a transaction is cancelled, the FHIR Task resource that was provided to ZorgDomein during SSO (for the initial submission of the transaction) is updated at the source system using a FHIR update (HTTP PUT) request. The body of the request will contain the original content of the Task resource, where Task.status is set to cancelled.
The canonical URL for this profile is:
http://zorgdomein.nl/fhir/StructureDefinition/zd-task
This profile builds on Task.
| Task | 0..* | Task | There are no (further) constraints on this element Element IdTask A task to be performed DefinitionA task to be performed.
| |
| identifier | 0..* | Identifier | There are no (further) constraints on this element Element IdTask.identifier Task Instance Identifier DefinitionThe business identifier for this task.
| |
| definition[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdTask.definition[x] Formal definition of task DefinitionA reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc. 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. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
| |
| definitionUri | uri | There are no (further) constraints on this element Data Type | ||
| definitionReference | Reference(ActivityDefinition) | There are no (further) constraints on this element Data Type | ||
| basedOn | Σ | 0..* | Reference(Resource) | Element IdTask.basedOn Reference to the related transaction when the task is started in response to a previous transaction DefinitionBasedOn 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| reference | Σ | 0..1 | string | There are no (further) constraints on this element Element IdTask.basedOn.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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.
|
| identifier | Σ | 1..1 | Identifier | Element IdTask.basedOn.identifier ZD number of the related transaction DefinitionAn 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. 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.
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdTask.basedOn.identifier.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdTask.basedOn.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Identifier Type Codes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element IdTask.basedOn.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://zorgdomein.nl/zdnumber
|
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdTask.basedOn.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
General 123456 Mappings
|
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element IdTask.basedOn.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
| assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdTask.basedOn.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdTask.basedOn.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
|
| groupIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdTask.groupIdentifier Requisition or grouper id DefinitionAn identifier that links together multiple tasks and other requests that were created in the same context. Billing and/or reporting can be linked to whether multiple requests were created as a single unit.
|
| partOf | Σ | 0..* | Reference(Task) | There are no (further) constraints on this element Element IdTask.partOf Composite task DefinitionTask that this particular task is part of. Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task). This should usually be 0..1.
|
| status | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdTask.status draft | requested | received | accepted | + DefinitionThe current status of the task. These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. Note that FHIR strings may not exceed 1MB in size
|
| statusReason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdTask.statusReason Reason for current status DefinitionAn explanation as to why this task is held, failed, was refused, etc. This applies to the current status. Look at the history of the task to see reasons for past statuses.
|
| businessStatus | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdTask.businessStatus E.g. "Specimen collected", "IV prepped" DefinitionContains business-specific nuances of the business state. There's often a need to track substates of a task - this is often variable by specific workflow implementation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
|
| intent | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element IdTask.intent proposal | plan | order + DefinitionIndicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc. This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order".
|
| priority | 0..1 | codeBinding | There are no (further) constraints on this element Element IdTask.priority normal | urgent | asap | stat DefinitionIndicates how quickly the Task should be addressed with respect to other requests. Used to identify the service level expected while performing a task. Note that FHIR strings may not exceed 1MB in size
| |
| code | Σ | 1..1 | CodeableConceptBinding | Element IdTask.code Specifies the task the user intents to perform when launching ZorgDomein DefinitionA name or code (or both) briefly describing what the task involves. The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.
|
| description | Σ | 0..1 | string | There are no (further) constraints on this element Element IdTask.description Human-readable explanation of task DefinitionA free-text description of what is to be performed. Note that FHIR strings may not exceed 1MB in size
|
| focus | Σ | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element IdTask.focus What task is acting on DefinitionThe request being actioned or the resource being manipulated by this task. Used to identify the thing to be done. If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).
|
| for | Σ | 0..1 | Reference(ZD Patient) | Element IdTask.for Patient for whom this task is started Alternate namesPatient DefinitionThe entity who benefits from the performance of the service specified in the task (e.g., the patient). 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | There are no (further) constraints on this element Element IdTask.context Healthcare event during which this task originated DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. For some tasks it may be important to know the link between the task or episode of care the task originated within. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Encounter | EpisodeOfCare) Constraints
|
| executionPeriod | Σ | 0..1 | Period | There are no (further) constraints on this element Element IdTask.executionPeriod Start and end time of execution DefinitionIdentifies 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). This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
| authoredOn | 0..1 | dateTime | There are no (further) constraints on this element Element IdTask.authoredOn Task Creation Date Alternate namesCreated Date DefinitionThe date and time this task was created. Most often used along with lastUpdated to track duration of task to supporting monitoring and management.
| |
| lastModified | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdTask.lastModified Task Last Modified Date Alternate namesUpdate Date DefinitionThe date and time of last modification to this task. Used along with history to track task activity and time in a particular task state. This enables monitoring and management.
|
| requester | Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdTask.requester Who is asking for task to be done DefinitionThe creator of the task. Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).
|
| agent | Σ | 1..1 | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) | There are no (further) constraints on this element Element IdTask.requester.agent Individual asking for task Alternate namesInitiator, Author DefinitionThe device, practitioner, etc. who initiated the task. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Organization | Patient | Practitioner | RelatedPerson) Constraints
|
| onBehalfOf | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdTask.requester.onBehalfOf Organization individual is acting for DefinitionThe organization the device or practitioner was acting on behalf of when they initiated the task. Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
| |
| performerType | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element IdTask.performerType requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer DefinitionThe type of participant that can execute the task. Use to distinguish tasks on different activity queues. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
| owner | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) | Element IdTask.owner Intended recipient of the transaction Alternate namesPerformer, Executer DefinitionIndividual organization or Device currently responsible for task execution. Identifies who is expected to perform this task. Tasks may be created with an owner not yet identified. Reference(Device | Organization | Patient | Practitioner | RelatedPerson) Constraints
|
| reference | Σ | 0..1 | string | There are no (further) constraints on this element Element IdTask.owner.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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.
|
| identifier | Σ | 0..1 | Identifier | Element IdTask.owner.identifier AGB-code of the intended recipient DefinitionAn 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. 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.
|
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdTask.owner.identifier.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
|
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdTask.owner.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Identifier Type Codes (extensible) Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element IdTask.owner.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://fhir.nl/fhir/NamingSystem/agb-z
|
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element IdTask.owner.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
General 123456 Mappings
|
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element IdTask.owner.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
| assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdTask.owner.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
| display | Σ | 0..1 | string | Element IdTask.owner.display Name of the intended recipient DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
|
| reason | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdTask.reason Why task is needed DefinitionA description or code indicating why this task needs to be performed. This should only be included if there is no focus or if it differs from the reason indicated on the focus.
| |
| note | 0..* | Annotation | There are no (further) constraints on this element Element IdTask.note Comments made about the task DefinitionFree-text information captured about the task as it progresses. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
| |
| relevantHistory | 0..* | Reference(Provenance) | There are no (further) constraints on this element Element IdTask.relevantHistory Key events in history of the Task Alternate namesStatus History DefinitionLinks 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. 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.
| |
| restriction | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdTask.restriction Constraints on fulfillment tasks DefinitionIf 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. Sometimes when fulfillment is sought, you don't want full fulfillment.
| |
| repetitions | 0..1 | positiveInt | There are no (further) constraints on this element Element IdTask.restriction.repetitions How many times to repeat DefinitionIndicates the number of times the requested action should occur. E.g. order that requests monthly lab tests, fulfillment is sought for 1. 32 bit number; for values larger than this, use decimal
| |
| period | 0..1 | Period | There are no (further) constraints on this element Element IdTask.restriction.period When fulfillment sought DefinitionOver what time-period is fulfillment sought. E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months. Note that period.high is the due date representing the time by which the task should be completed.
| |
| recipient | 0..* | Reference(Patient | Practitioner | RelatedPerson | Group | Organization) | There are no (further) constraints on this element Element IdTask.restriction.recipient For whom is fulfillment sought? DefinitionFor requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought? References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | Practitioner | RelatedPerson | Group | Organization) Constraints
| |
| input | 0..* | BackboneElement | Element IdTask.input Addtional input parameters for performing the task in ZorgDomein Alternate namesSupporting Information DefinitionAdditional information that may be needed in the execution of the task. 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. Unordered, Open, by type.coding.code(Value) Constraints
| |
| (All Slices) | There are no (further) constraints on this element | |||
| type | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdTask.input.type Label for the input Alternate namesName DefinitionA code or description indicating how the input is intended to be used as part of the task execution. Inputs are named to enable task automation to bind data and pass it from one task to the next. 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.
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element IdTask.input.value[x] Content to use in performing the task DefinitionThe value of the input parameter as a basic type. A stream of bytes, base64 encoded
| ||
| valueBase64Binary | base64Binary | There are no (further) constraints on this element Data Type | ||
| valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
| valueCode | code | There are no (further) constraints on this element Data Type | ||
| valueDate | date | There are no (further) constraints on this element Data Type | ||
| valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
| valueDecimal | decimal | There are no (further) constraints on this element Data Type | ||
| valueId | id | There are no (further) constraints on this element Data Type | ||
| valueInstant | instant | There are no (further) constraints on this element Data Type | ||
| valueInteger | integer | There are no (further) constraints on this element Data Type | ||
| valueMarkdown | markdown | There are no (further) constraints on this element Data Type | ||
| valueOid | oid | There are no (further) constraints on this element Data Type | ||
| valuePositiveInt | positiveInt | There are no (further) constraints on this element Data Type | ||
| valueString | string | There are no (further) constraints on this element Data Type | ||
| valueTime | time | There are no (further) constraints on this element Data Type | ||
| valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data Type | ||
| valueUri | uri | There are no (further) constraints on this element Data Type | ||
| valueAddress | Address | There are no (further) constraints on this element Data Type | ||
| valueAge | Age | There are no (further) constraints on this element Data Type | ||
| valueAnnotation | Annotation | There are no (further) constraints on this element Data Type | ||
| valueAttachment | Attachment | There are no (further) constraints on this element Data Type | ||
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
| valueCoding | Coding | There are no (further) constraints on this element Data Type | ||
| valueContactPoint | ContactPoint | There are no (further) constraints on this element Data Type | ||
| valueCount | Count | There are no (further) constraints on this element Data Type | ||
| valueDistance | Distance | There are no (further) constraints on this element Data Type | ||
| valueDuration | Duration | There are no (further) constraints on this element Data Type | ||
| valueHumanName | HumanName | There are no (further) constraints on this element Data Type | ||
| valueIdentifier | Identifier | There are no (further) constraints on this element Data Type | ||
| valueMoney | Money | There are no (further) constraints on this element Data Type | ||
| valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
| valueQuantity | Quantity | There are no (further) constraints on this element Data Type | ||
| valueRange | Range | There are no (further) constraints on this element Data Type | ||
| valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
| valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
| valueSignature | Signature | There are no (further) constraints on this element Data Type | ||
| valueTiming | Timing | There are no (further) constraints on this element Data Type | ||
| valueMeta | Meta | There are no (further) constraints on this element Data Type | ||
| valueReference | Reference() | There are no (further) constraints on this element Data Type | ||
| message | 0..1 | BackboneElement | Element IdTask.input:message Reference to a pregenerated message or document Alternate namesSupporting Information DefinitionAdditional information that may be needed in the execution of the task. 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.
| |
| type | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdTask.input:message.type Label for the input Alternate namesName DefinitionA code or description indicating how the input is intended to be used as part of the task execution. Inputs are named to enable task automation to bind data and pass it from one task to the next. 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.
| |
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element IdTask.input:message.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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 labeled as UserSelected = true.
|
| system | Σ | 1..1 | uriFixed Value | Element IdTask.input:message.type.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
http://zorgdomein.nl/terminology/code-system/launch-input-type
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdTask.input:message.type.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ | 1..1 | codeFixed Value | Element IdTask.input:message.type.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size
message
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdTask.input:message.type.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdTask.input:message.type.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdTask.input:message.type.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
| valueReference | 1..1 | Reference(ZD Communication) | Element IdTask.input:message.value[x]:valueReference Content to use in performing the task DefinitionThe value of the input parameter as a basic type. A stream of bytes, base64 encoded
| |
| reference | Σ | 1..1 | string | There are no (further) constraints on this element Element IdTask.input:message.value[x]:valueReference.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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.
|
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdTask.input:message.value[x]:valueReference.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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.
|
| display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdTask.input:message.value[x]:valueReference.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
|
| output | 0..* | BackboneElement | There are no (further) constraints on this element Element IdTask.output Information produced as part of task DefinitionOutputs produced by the Task. 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.
| |
| type | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdTask.output.type Label for output Alternate namesName DefinitionThe name of the Output parameter. Outputs are named to enable task automation to bind data and pass it from one task to the next. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element IdTask.output.value[x] Result of output DefinitionThe value of the Output parameter as a basic type. Task outputs can take any form. A stream of bytes, base64 encoded
| ||
| valueBase64Binary | base64Binary | There are no (further) constraints on this element Data Type | ||
| valueBoolean | boolean | There are no (further) constraints on this element Data Type | ||
| valueCode | code | There are no (further) constraints on this element Data Type | ||
| valueDate | date | There are no (further) constraints on this element Data Type | ||
| valueDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
| valueDecimal | decimal | There are no (further) constraints on this element Data Type | ||
| valueId | id | There are no (further) constraints on this element Data Type | ||
| valueInstant | instant | There are no (further) constraints on this element Data Type | ||
| valueInteger | integer | There are no (further) constraints on this element Data Type | ||
| valueMarkdown | markdown | There are no (further) constraints on this element Data Type | ||
| valueOid | oid | There are no (further) constraints on this element Data Type | ||
| valuePositiveInt | positiveInt | There are no (further) constraints on this element Data Type | ||
| valueString | string | There are no (further) constraints on this element Data Type | ||
| valueTime | time | There are no (further) constraints on this element Data Type | ||
| valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data Type | ||
| valueUri | uri | There are no (further) constraints on this element Data Type | ||
| valueAddress | Address | There are no (further) constraints on this element Data Type | ||
| valueAge | Age | There are no (further) constraints on this element Data Type | ||
| valueAnnotation | Annotation | There are no (further) constraints on this element Data Type | ||
| valueAttachment | Attachment | There are no (further) constraints on this element Data Type | ||
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
| valueCoding | Coding | There are no (further) constraints on this element Data Type | ||
| valueContactPoint | ContactPoint | There are no (further) constraints on this element Data Type | ||
| valueCount | Count | There are no (further) constraints on this element Data Type | ||
| valueDistance | Distance | There are no (further) constraints on this element Data Type | ||
| valueDuration | Duration | There are no (further) constraints on this element Data Type | ||
| valueHumanName | HumanName | There are no (further) constraints on this element Data Type | ||
| valueIdentifier | Identifier | There are no (further) constraints on this element Data Type | ||
| valueMoney | Money | There are no (further) constraints on this element Data Type | ||
| valuePeriod | Period | There are no (further) constraints on this element Data Type | ||
| valueQuantity | Quantity | There are no (further) constraints on this element Data Type | ||
| valueRange | Range | There are no (further) constraints on this element Data Type | ||
| valueRatio | Ratio | There are no (further) constraints on this element Data Type | ||
| valueSampledData | SampledData | There are no (further) constraints on this element Data Type | ||
| valueSignature | Signature | There are no (further) constraints on this element Data Type | ||
| valueTiming | Timing | There are no (further) constraints on this element Data Type | ||
| valueMeta | Meta | There are no (further) constraints on this element Data Type | ||
| valueReference | Reference() | There are no (further) constraints on this element Data Type |
See the profile on simplifier.net for additional details.
Resource example
Below you find an example of a Task resource that conforms to the ZD Task profile.
{
"resourceType": "Task",
"meta": {
"profile": [
"http://zorgdomein.nl/fhir/StructureDefinition/zd-task"
]
},
"basedOn": [
{
"identifier": {
"system": "http://zorgdomein.nl/zdnumber",
"value": "ZD23456789"
}
}
],
"status": "requested",
"intent": "order",
"code": {
"coding": [
{
"system": "http://zorgdomein.nl/terminology/code-system/launch-intent",
"code": "send-progress-report"
}
]
},
"for": {
"reference": "Patient/1"
},
"owner": {
"display": "IO Huisarts"
},
"input": [
{
"type": {
"coding": [
{
"system": "http://zorgdomein.nl/terminology/code-system/launch-input-type",
"code": "message"
}
]
},
"valueReference": {
"reference": "https://tio.zorgdomein.nl/fhir-test-server/baseDstu3/Communication/1866"
}
}
]
}
<Task xmlns='http://hl7.org/fhir'>
<meta>
<profile value='http://zorgdomein.nl/fhir/StructureDefinition/zd-task'/>
</meta>
<basedOn>
<identifier>
<system value='http://zorgdomein.nl/zdnumber'/>
<value value='ZD23456789'/>
</identifier>
</basedOn>
<status value='requested'/>
<intent value='order'/>
<code>
<coding>
<system value='http://zorgdomein.nl/terminology/code-system/launch-intent'/>
<code value='send-progress-report'/>
</coding>
</code>
<for>
<reference value='Patient/1'/>
</for>
<owner>
<display value='IO Huisarts'/>
</owner>
<input>
<type>
<coding>
<system value='http://zorgdomein.nl/terminology/code-system/launch-input-type'/>
<code value='message'/>
</coding>
</type>
<valueReference>
<reference value='https://tio.zorgdomein.nl/fhir-test-server/baseDstu3/Communication/1866'/>
</valueReference>
</input>
</Task>