DRAFT - The specification is currently in development and subject to significant change. It is not ready for limited roll-out or production level use.
Task (CA:eReC)
Structure Definition: Task Profile
Canonical URL:http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Task
Simplifier project page: Task
Derived from: Task (R4)
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work
Task | I | Task | There are no (further) constraints on this element Element idTask A task to be performed DefinitionA task to be performed.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idTask.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idTask.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idTask.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idTask.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idTask.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can 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. 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 information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idTask.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | Element idTask.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
PatientNeedsToBeSeen | S I | 0..1 | Extension(boolean) | Element idTask.extension:PatientNeedsToBeSeen Optional Extensions Element Alternate namesextensions, user content DefinitionFollowing a consult, used to communicate if a patient needs to be seen in person. Used to support the eConsult use case where a patient is referred to a care provider. Used for when the care provider responds with an eConsult rather than accept the referral, but the patient wants a referral anyway. http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-patient-needs-to-be-seen-EXT Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idTask.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | 0..* | Identifier | There are no (further) constraints on this element Element idTask.identifier Task Instance Identifier DefinitionThe business identifier for this task.
| |
instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | There are no (further) constraints on this element Element idTask.instantiatesCanonical Formal definition of task DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. Enables a formal definition of how he task is to be performed, enabling automation.
|
instantiatesUri | Σ | 0..1 | uri | There are no (further) constraints on this element Element idTask.instantiatesUri Formal definition of task DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. 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
|
basedOn | S Σ I | 1..1 | Reference(ServiceRequest) | Element idTask.basedOn Request fulfilled by this task DefinitionBasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill 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. Allowed aggregation: referenced Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.basedOn.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.basedOn.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | S Σ I | 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idTask.basedOn.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idTask.basedOn.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.basedOn.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.basedOn.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idTask.basedOn.identifier.use usual | official | temp | secondary | old (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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 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. 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"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 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 | Σ I | 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 | S Σ ?! | 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 SHALL NOT exceed 1MB in size The current status of the task.
|
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. Codes to identify the reason for current status. These will typically be specific to a particular workflow.
|
businessStatus | S Σ | 0..1 | CodeableConceptBinding | 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. The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.businessStatus.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.businessStatus.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
StatusReason | S I | 0..1 | Extension(CodeableConcept) | Element idTask.businessStatus.extension:StatusReason BusinessStatusReason Alternate namesextensions, user content DefinitionA reason for why the business reason is as it is. 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.
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idTask.businessStatus.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idTask.businessStatus.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.
|
intent | S Σ | 1..1 | codeBindingPattern | Element idTask.intent unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option DefinitionIndicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs 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". Distinguishes whether the task is a proposal, plan or full order.
proposal
|
priority | 0..1 | codeBinding | There are no (further) constraints on this element Element idTask.priority routine | 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 SHALL NOT exceed 1MB in size If missing, this task should be performed with normal priority The task's priority.
| |
code | S Σ | 0..1 | CodeableConceptBinding | Element idTask.code Task Type DefinitionA name or code (or both) briefly describing what the task involves. Codes to identify what the task involves. These will typically be specific to a particular workflow.
|
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 SHALL NOT exceed 1MB in size
|
focus | Σ I | 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 | Σ I | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idTask.for Beneficiary of the Task 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.
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idTask.encounter 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 encounter 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.
|
executionPeriod | Σ I | 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). 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"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
authoredOn | S I | 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 | Σ I | 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 | Σ I | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 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). 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 | PractitionerRole | RelatedPerson) Constraints
|
performerType | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idTask.performerType Requested performer DefinitionThe kind of participant that should perform 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. The type(s) of task performers allowed.
| |
owner | S Σ I | 0..1 | Reference(PractitionerRole) | Element idTask.owner Responsible individual 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.owner.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.owner.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | S Σ I | 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idTask.owner.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idTask.owner.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.owner.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.owner.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idTask.owner.identifier.use usual | official | temp | secondary | old (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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 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. 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"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 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 | There are no (further) constraints on this element Element idTask.owner.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.
|
location | Σ I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idTask.location Where task occurs DefinitionPrincipal physical location where the this task is performed. Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). 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.
|
reasonCode | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idTask.reasonCode 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. Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.
| |
reasonReference | I | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idTask.reasonReference Why task is needed DefinitionA resource reference indicating why this task needs to be performed. Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in
|
insurance | I | 0..* | Reference(Coverage | ClaimResponse) | There are no (further) constraints on this element Element idTask.insurance Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to 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(Coverage | ClaimResponse) Constraints
|
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 | I | 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idTask.restriction.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.restriction.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idTask.restriction.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
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 | I | 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 | I | 0..* | Reference(Patient | Practitioner | PractitionerRole | 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 | PractitionerRole | RelatedPerson | Group | Organization) Constraints
|
input | 0..* | BackboneElement | There are no (further) constraints on this element Element idTask.input Information used to perform task 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idTask.input.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.input.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idTask.input.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
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. Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
| |
value[x] | 1..1 | 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.
| ||
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueCanonical | canonical() | 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 | ||
valueUrl | url | There are no (further) constraints on this element Data type | ||
valueUuid | uuid | 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 | ||
valueContactDetail | ContactDetail | There are no (further) constraints on this element Data type | ||
valueContributor | Contributor | There are no (further) constraints on this element Data type | ||
valueDataRequirement | DataRequirement | There are no (further) constraints on this element Data type | ||
valueExpression | Expression | There are no (further) constraints on this element Data type | ||
valueParameterDefinition | ParameterDefinition | There are no (further) constraints on this element Data type | ||
valueRelatedArtifact | RelatedArtifact | There are no (further) constraints on this element Data type | ||
valueTriggerDefinition | TriggerDefinition | There are no (further) constraints on this element Data type | ||
valueUsageContext | UsageContext | There are no (further) constraints on this element Data type | ||
valueDosage | Dosage | 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 | ||
output | S | 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.output.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.output.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idTask.output.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
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. Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.
| |
value[x] | S | 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.
| |
valueReference | Reference(Communication) | Data type |
Task | I | Task | There are no (further) constraints on this element Element idTask A task to be performed DefinitionA task to be performed.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idTask.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idTask.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idTask.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idTask.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idTask.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can 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. 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 information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idTask.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | Element idTask.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
PatientNeedsToBeSeen | S I | 0..1 | Extension(boolean) | Element idTask.extension:PatientNeedsToBeSeen Optional Extensions Element Alternate namesextensions, user content DefinitionFollowing a consult, used to communicate if a patient needs to be seen in person. Used to support the eConsult use case where a patient is referred to a care provider. Used for when the care provider responds with an eConsult rather than accept the referral, but the patient wants a referral anyway. http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-patient-needs-to-be-seen-EXT Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idTask.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | 0..* | Identifier | There are no (further) constraints on this element Element idTask.identifier Task Instance Identifier DefinitionThe business identifier for this task.
| |
instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | There are no (further) constraints on this element Element idTask.instantiatesCanonical Formal definition of task DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. Enables a formal definition of how he task is to be performed, enabling automation.
|
instantiatesUri | Σ | 0..1 | uri | There are no (further) constraints on this element Element idTask.instantiatesUri Formal definition of task DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. 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
|
basedOn | S Σ I | 1..1 | Reference(ServiceRequest) | Element idTask.basedOn Request fulfilled by this task DefinitionBasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill 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. Allowed aggregation: referenced Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.basedOn.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.basedOn.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | S Σ I | 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idTask.basedOn.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idTask.basedOn.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.basedOn.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.basedOn.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idTask.basedOn.identifier.use usual | official | temp | secondary | old (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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 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. 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"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 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 | Σ I | 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 | S Σ ?! | 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 SHALL NOT exceed 1MB in size The current status of the task.
|
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. Codes to identify the reason for current status. These will typically be specific to a particular workflow.
|
businessStatus | S Σ | 0..1 | CodeableConceptBinding | 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. The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.businessStatus.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.businessStatus.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
StatusReason | S I | 0..1 | Extension(CodeableConcept) | Element idTask.businessStatus.extension:StatusReason BusinessStatusReason Alternate namesextensions, user content DefinitionA reason for why the business reason is as it is. 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.
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idTask.businessStatus.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idTask.businessStatus.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.
|
intent | S Σ | 1..1 | codeBindingPattern | Element idTask.intent unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option DefinitionIndicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs 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". Distinguishes whether the task is a proposal, plan or full order.
proposal
|
priority | 0..1 | codeBinding | There are no (further) constraints on this element Element idTask.priority routine | 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 SHALL NOT exceed 1MB in size If missing, this task should be performed with normal priority The task's priority.
| |
code | S Σ | 0..1 | CodeableConceptBinding | Element idTask.code Task Type DefinitionA name or code (or both) briefly describing what the task involves. Codes to identify what the task involves. These will typically be specific to a particular workflow.
|
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 SHALL NOT exceed 1MB in size
|
focus | Σ I | 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 | Σ I | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idTask.for Beneficiary of the Task 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.
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idTask.encounter 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 encounter 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.
|
executionPeriod | Σ I | 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). 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"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
authoredOn | S I | 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 | Σ I | 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 | Σ I | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 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). 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 | PractitionerRole | RelatedPerson) Constraints
|
performerType | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idTask.performerType Requested performer DefinitionThe kind of participant that should perform 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. The type(s) of task performers allowed.
| |
owner | S Σ I | 0..1 | Reference(PractitionerRole) | Element idTask.owner Responsible individual 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.owner.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.owner.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | S Σ I | 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idTask.owner.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idTask.owner.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.owner.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.owner.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idTask.owner.identifier.use usual | official | temp | secondary | old (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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 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. 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"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 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 | There are no (further) constraints on this element Element idTask.owner.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.
|
location | Σ I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idTask.location Where task occurs DefinitionPrincipal physical location where the this task is performed. Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). 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.
|
reasonCode | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idTask.reasonCode 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. Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.
| |
reasonReference | I | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idTask.reasonReference Why task is needed DefinitionA resource reference indicating why this task needs to be performed. Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in
|
insurance | I | 0..* | Reference(Coverage | ClaimResponse) | There are no (further) constraints on this element Element idTask.insurance Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to 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(Coverage | ClaimResponse) Constraints
|
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 | I | 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idTask.restriction.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.restriction.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idTask.restriction.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
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 | I | 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 | I | 0..* | Reference(Patient | Practitioner | PractitionerRole | 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 | PractitionerRole | RelatedPerson | Group | Organization) Constraints
|
input | 0..* | BackboneElement | There are no (further) constraints on this element Element idTask.input Information used to perform task 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idTask.input.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.input.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idTask.input.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
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. Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
| |
value[x] | 1..1 | 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.
| ||
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueCanonical | canonical() | 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 | ||
valueUrl | url | There are no (further) constraints on this element Data type | ||
valueUuid | uuid | 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 | ||
valueContactDetail | ContactDetail | There are no (further) constraints on this element Data type | ||
valueContributor | Contributor | There are no (further) constraints on this element Data type | ||
valueDataRequirement | DataRequirement | There are no (further) constraints on this element Data type | ||
valueExpression | Expression | There are no (further) constraints on this element Data type | ||
valueParameterDefinition | ParameterDefinition | There are no (further) constraints on this element Data type | ||
valueRelatedArtifact | RelatedArtifact | There are no (further) constraints on this element Data type | ||
valueTriggerDefinition | TriggerDefinition | There are no (further) constraints on this element Data type | ||
valueUsageContext | UsageContext | There are no (further) constraints on this element Data type | ||
valueDosage | Dosage | 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 | ||
output | S | 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.output.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.output.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idTask.output.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
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. Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.
| |
value[x] | S | 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.
| |
valueReference | Reference(Communication) | Data type |
Task | I | Task | There are no (further) constraints on this element Element idTask A task to be performed DefinitionA task to be performed.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idTask.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idTask.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idTask.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idTask.language Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idTask.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can 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. 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 information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idTask.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | Element idTask.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
PatientNeedsToBeSeen | S I | 0..1 | Extension(boolean) | Element idTask.extension:PatientNeedsToBeSeen Optional Extensions Element Alternate namesextensions, user content DefinitionFollowing a consult, used to communicate if a patient needs to be seen in person. Used to support the eConsult use case where a patient is referred to a care provider. Used for when the care provider responds with an eConsult rather than accept the referral, but the patient wants a referral anyway. http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-patient-needs-to-be-seen-EXT Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idTask.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | 0..* | Identifier | There are no (further) constraints on this element Element idTask.identifier Task Instance Identifier DefinitionThe business identifier for this task.
| |
instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | There are no (further) constraints on this element Element idTask.instantiatesCanonical Formal definition of task DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. Enables a formal definition of how he task is to be performed, enabling automation.
|
instantiatesUri | Σ | 0..1 | uri | There are no (further) constraints on this element Element idTask.instantiatesUri Formal definition of task DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. 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
|
basedOn | S Σ I | 1..1 | Reference(ServiceRequest) | Element idTask.basedOn Request fulfilled by this task DefinitionBasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill 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. Allowed aggregation: referenced Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.basedOn.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.basedOn.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | S Σ I | 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idTask.basedOn.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idTask.basedOn.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.basedOn.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.basedOn.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idTask.basedOn.identifier.use usual | official | temp | secondary | old (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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 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. 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"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 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 | Σ I | 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 | S Σ ?! | 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 SHALL NOT exceed 1MB in size The current status of the task.
|
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. Codes to identify the reason for current status. These will typically be specific to a particular workflow.
|
businessStatus | S Σ | 0..1 | CodeableConceptBinding | 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. The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.businessStatus.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.businessStatus.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
StatusReason | S I | 0..1 | Extension(CodeableConcept) | Element idTask.businessStatus.extension:StatusReason BusinessStatusReason Alternate namesextensions, user content DefinitionA reason for why the business reason is as it is. 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.
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idTask.businessStatus.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idTask.businessStatus.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.
|
intent | S Σ | 1..1 | codeBindingPattern | Element idTask.intent unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option DefinitionIndicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs 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". Distinguishes whether the task is a proposal, plan or full order.
proposal
|
priority | 0..1 | codeBinding | There are no (further) constraints on this element Element idTask.priority routine | 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 SHALL NOT exceed 1MB in size If missing, this task should be performed with normal priority The task's priority.
| |
code | S Σ | 0..1 | CodeableConceptBinding | Element idTask.code Task Type DefinitionA name or code (or both) briefly describing what the task involves. Codes to identify what the task involves. These will typically be specific to a particular workflow.
|
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 SHALL NOT exceed 1MB in size
|
focus | Σ I | 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 | Σ I | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idTask.for Beneficiary of the Task 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.
|
encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idTask.encounter 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 encounter 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.
|
executionPeriod | Σ I | 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). 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"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
authoredOn | S I | 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 | Σ I | 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 | Σ I | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 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). 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 | PractitionerRole | RelatedPerson) Constraints
|
performerType | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idTask.performerType Requested performer DefinitionThe kind of participant that should perform 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. The type(s) of task performers allowed.
| |
owner | S Σ I | 0..1 | Reference(PractitionerRole) | Element idTask.owner Responsible individual 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.owner.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.owner.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | S Σ I | 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idTask.owner.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idTask.owner.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.owner.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.owner.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idTask.owner.identifier.use usual | official | temp | secondary | old (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. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 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. 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"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 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 | There are no (further) constraints on this element Element idTask.owner.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.
|
location | Σ I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idTask.location Where task occurs DefinitionPrincipal physical location where the this task is performed. Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). 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.
|
reasonCode | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idTask.reasonCode 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. Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.
| |
reasonReference | I | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idTask.reasonReference Why task is needed DefinitionA resource reference indicating why this task needs to be performed. Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in
|
insurance | I | 0..* | Reference(Coverage | ClaimResponse) | There are no (further) constraints on this element Element idTask.insurance Associated insurance coverage DefinitionInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to 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(Coverage | ClaimResponse) Constraints
|
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 | I | 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idTask.restriction.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.restriction.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idTask.restriction.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
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 | I | 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 | I | 0..* | Reference(Patient | Practitioner | PractitionerRole | 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 | PractitionerRole | RelatedPerson | Group | Organization) Constraints
|
input | 0..* | BackboneElement | There are no (further) constraints on this element Element idTask.input Information used to perform task 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idTask.input.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.input.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idTask.input.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
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. Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
| |
value[x] | 1..1 | 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.
| ||
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueCanonical | canonical() | 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 | ||
valueUrl | url | There are no (further) constraints on this element Data type | ||
valueUuid | uuid | 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 | ||
valueContactDetail | ContactDetail | There are no (further) constraints on this element Data type | ||
valueContributor | Contributor | There are no (further) constraints on this element Data type | ||
valueDataRequirement | DataRequirement | There are no (further) constraints on this element Data type | ||
valueExpression | Expression | There are no (further) constraints on this element Data type | ||
valueParameterDefinition | ParameterDefinition | There are no (further) constraints on this element Data type | ||
valueRelatedArtifact | RelatedArtifact | There are no (further) constraints on this element Data type | ||
valueTriggerDefinition | TriggerDefinition | There are no (further) constraints on this element Data type | ||
valueUsageContext | UsageContext | There are no (further) constraints on this element Data type | ||
valueDosage | Dosage | 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 | ||
output | S | 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idTask.output.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idTask.output.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idTask.output.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
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. Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.
| |
value[x] | S | 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.
| |
valueReference | Reference(Communication) | Data type |
Task | .. | |
Task.extension | .. | |
Task.extension | Extension | 0..1 |
Task.basedOn | Reference(ServiceRequest) | 1..1 |
Task.basedOn.reference | .. | |
Task.basedOn.identifier | .. | |
Task.basedOn.identifier.system | 1.. | |
Task.basedOn.identifier.value | 1.. | |
Task.status | .. | |
Task.businessStatus | .. | |
Task.businessStatus.extension | Extension | 0..1 |
Task.intent | .. | |
Task.code | .. | |
Task.authoredOn | .. | |
Task.owner | Reference(PractitionerRole) | .. |
Task.owner.reference | .. | |
Task.owner.identifier | .. | |
Task.owner.identifier.system | 1.. | |
Task.owner.identifier.value | 1.. | |
Task.output | .. | |
Task.output.value[x] | Reference(Communication) | .. |
{ "resourceType": "StructureDefinition", "id": "CA-eReC-Task", "url": "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Task", "version": "1.0.0", "name": "Task", "title": "Task", "status": "draft", "description": "A task resource describes an activity that can be performed and tracks the state of completion of that activity. It is a representation that an activity should be or has been initiated, and eventually, represents the successful or unsuccessful completion of that activity.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Task", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Task", "derivation": "constraint", "differential": { "element": [ { "id": "Task.extension", "path": "Task.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "ordered": false, "rules": "open" } }, { "id": "Task.extension:PatientNeedsToBeSeen", "path": "Task.extension", "sliceName": "PatientNeedsToBeSeen", "comment": "Used to support the eConsult use case where a patient is referred to a care provider. Used for when the care provider responds with an eConsult rather than accept the referral, but the patient wants a referral anyway.", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-patient-needs-to-be-seen-EXT" ] } ] }, { "id": "Task.basedOn", "path": "Task.basedOn", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-ServiceRequest" ], "aggregation": [ "referenced" ] } ], "mustSupport": true }, { "id": "Task.basedOn.reference", "path": "Task.basedOn.reference", "mustSupport": true }, { "id": "Task.basedOn.identifier", "path": "Task.basedOn.identifier", "mustSupport": true }, { "id": "Task.basedOn.identifier.system", "path": "Task.basedOn.identifier.system", "min": 1, "mustSupport": true }, { "id": "Task.basedOn.identifier.value", "path": "Task.basedOn.identifier.value", "min": 1, "mustSupport": true }, { "id": "Task.status", "path": "Task.status", "mustSupport": true }, { "id": "Task.businessStatus", "path": "Task.businessStatus", "mustSupport": true, "binding": { "strength": "extensible", "valueSet": "http://fhir.infoway-inforoute.ca/io/CA-eReC/ValueSet/task-business-status" } }, { "id": "Task.businessStatus.extension:StatusReason", "path": "Task.businessStatus.extension", "sliceName": "StatusReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-task-business-status-reason-EXT" ] } ], "mustSupport": true }, { "id": "Task.intent", "path": "Task.intent", "patternCode": "proposal", "mustSupport": true }, { "id": "Task.code", "path": "Task.code", "comment": "-", "mustSupport": true, "binding": { "strength": "extensible", "valueSet": "http://fhir.infoway-inforoute.ca/io/CA-eReC/ValueSet/task-code" } }, { "id": "Task.authoredOn", "path": "Task.authoredOn", "mustSupport": true }, { "id": "Task.owner", "path": "Task.owner", "type": [ { "code": "Reference", "targetProfile": [ "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-PractitionerRole" ] } ], "mustSupport": true }, { "id": "Task.owner.reference", "path": "Task.owner.reference", "mustSupport": true }, { "id": "Task.owner.identifier", "path": "Task.owner.identifier", "mustSupport": true }, { "id": "Task.owner.identifier.system", "path": "Task.owner.identifier.system", "min": 1, "mustSupport": true }, { "id": "Task.owner.identifier.value", "path": "Task.owner.identifier.value", "min": 1, "mustSupport": true }, { "id": "Task.output", "path": "Task.output", "mustSupport": true }, { "id": "Task.output.value[x]", "path": "Task.output.value[x]", "type": [ { "code": "Reference", "targetProfile": [ "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Communication" ] } ], "mustSupport": true } ] } }
Usage
The Task resource is used as follows in this IG:
a "Process Request" Task (
"Task.code": "process-request"
) SHALL be used by a Target System to track and communicate the status of a referral request to the Source Systema "Process Request Consult" Task (
"Task.code": "process-request-consult"
) SHALL be used by a Target System to track and communicate the status of a consult request to the Source System
Each Task SHALL reference the ServiceRequest it is basedOn
.
Notes
.id
- used to uniquely identify the resource
- if a persistent identity for the resource is not available to use when constructing a message Bundle for transmission via Direct Messaging, a UUID SHOULD be used in this element (with a corresponding value in
Bundle.entry.fullUrl
)
extension:PatientNeedsToBeSeen
- Used in the Ontario iGuide to support the eConsult use case where a patient is referred to a care provider, the care provider responds with an eConsult rather than accept the referral, but the patient wants a referral anyway.
.basedOn
- used to associate the Task with the ServiceRequest being performed
- SHALL be populated with a reference to the ServiceRequest being performed
- if the Task is being transmitted via messaging, this element SHALL either:
.reference
a resource included in the message as aBundle.entry
, or- include an
.identifier
previously known to both systems
.status
- for a "Process Request" Task, used to track the status of the ServiceRequest being performed as work progresses through to completion
- for a "Request for Information" Task, used to track the status of the request for information
.businessStatus
- used to convey the business status of the Task, which can be different from the
.status
. It can be more finegrained and is implementation-specific.
.businessStatus.extension:StatusReason
- provides a coded reason for the
.businessStatus
.intent
- only "proposal" SHALL be supported
- "plan" and "order" MAY be populated, and systems that do not understand "plan" or "order" codes will treat the value as "proposal"
.code
- identifies the type of task
- SHALL always be populated
- with "process-request" for a "Process Request" Task
- with "process-request-consult" for a "Process Request" eConsult Task
.authoredOn
- indicates the dateTime that the eReferral was received
- usually the same as ServiceRequest.authoredOn, except in cases when ServiceRequest.authoredOn is used to record that a request was signed by the requester before the transmission took place
.lastModified
- indicates the dateTime when an update of note/significance was made to the referral (i.e., related resources such as ServiceRequest, patient, Task, Appointment, etc...)
.owner
- a reference to the PractitionerRole responsible for handling the referral
- if the Task is being transmitted via messaging, this element SHALL either:
.reference
a resource included in the message as aBundle.entry
, or- include an
.identifier
previously known to both systems
.output
- MAY to used to provide the outcome of a Referral
- SHALL contain a reference to Communication when an eConsult is provided by a specialist