3.2. FHIR profiles

There are no (further) constraints on this element

Element id

Task.id

Short description

Logical id of this artifact

Definition

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

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Task.meta

Short description

Metadata about the resource

Definition

The 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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Task.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. 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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Task.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

text

0..1

There are no (further) constraints on this element

Element id

Task.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A 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.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

Task.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Element id

Task.extension

Short description

Reference to ActivityDefinition

Alternate names

extensions, user content

Definition

A link to the ActivityDefinition that defines the launchable eHealth activity (i.e., what module/content should be launched or performed) associated with this Task. In both MedMij and Koppeltaal implementations, this link is carried using the Koppeltaal instantiates extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

resource-origin

0..*

Element id

Task.extension:resource-origin

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May 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.

Comments

Data type

Extension URL

http://koppeltaal.nl/fhir/StructureDefinition/resource-origin

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

instantiates

0..*

Element id

Task.extension:instantiates

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension URL

http://vzvz.nl/fhir/StructureDefinition/instantiates

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Task.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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).

Requirements

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.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

1..*

There are no (further) constraints on this element

Element id

Task.identifier

Short description

Task Instance Identifier

Definition

The business identifier for this task.

Data type

canonical(ActivityDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.identifier, Event.identifier
w5: FiveWs.identifier
rim: .id

instantiatesCanonical

0..1

There are no (further) constraints on this element

Element id

Task.instantiatesCanonical

Short description

Formal definition of task

Definition

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.

Requirements

Enables a formal definition of how he task is to be performed, enabling automation.

Comments

see Canonical References

Data type

canonical(ActivityDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.instantiatesCanonical, Event.instantiatesCanonical
rim: .outboundRelationship[typeCode=DEFN].target

instantiatesUri

0..1

There are no (further) constraints on this element

Element id

Task.instantiatesUri

Short description

Formal definition of task

Definition

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.

Requirements

Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation to be associated with a task), enabling automation.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Event.instantiatesUrl
rim: .outboundRelationship[typeCode=DEFN].target

basedOn

Σ C

0..*

There are no (further) constraints on this element

Element id

Task.basedOn

Short description

Request fulfilled by this task

Definition

BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a 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.

Comments

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.basedOn, Event.basedOn
rim: .outboundRelationship[typeCode=FLFS].target[moodCode=INT]

groupIdentifier

0..1

Element id

Task.groupIdentifier

Short description

Requisition or grouper id

Definition

An identifier that links together multiple tasks and other requests that were created in the same context. The groupIdentifier (system/value pair) can be used to group and filter related Tasks (e.g., all tasks belonging to the same digital activity or workflow package). In this profile, groupIdentifier.type.text is used to provide a human-readable group label for display in the PGO.

Requirements

Billing and/or reporting can be linked to whether multiple requests were created as a single unit.

Data type

Reference(ProviderTasksTask)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.groupIdentifier
rim: .inboundRelationship[typeCode=COMP].source[moodCode=INT].id

partOf

Σ C

0..*

Element id

Task.partOf

Short description

Composite task

Definition

Task that this particular task is part of.

Requirements

Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).

Comments

This should usually be 0..1.

Data type

Reference(ProviderTasksTask)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.partOf
rim: .inboundRelationship[typeCode=COMP].source[moodCode=INT]

status

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

Task.status

Short description

draft | requested | received | accepted | +

Definition

The current status of the task.

Requirements

These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Binding

The current status of the task.

TaskStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.status, Event.status
w5: FiveWs.status
rim: .statusCode

statusReason

0..1

There are no (further) constraints on this element

Element id

Task.statusReason

Short description

Reason for current status

Definition

An explanation as to why this task is held, failed, was refused, etc.

Comments

This applies to the current status. Look at the history of the task to see reasons for past statuses.

Data type

Binding

Codes to identify the reason for current status. These will typically be specific to a particular workflow.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN, code="status change"].reasonCode

businessStatus

0..1

There are no (further) constraints on this element

Element id

Task.businessStatus

Short description

E.g. "Specimen collected", "IV prepped"

Definition

Contains business-specific nuances of the business state.

Requirements

There's often a need to track substates of a task - this is often variable by specific workflow implementation.

Comments

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.

Data type

Binding

The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="business status"]

intent

1..1

codeBinding

There are no (further) constraints on this element

Element id

Task.intent

Short description

Definition

Indicates 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.

Comments

This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.

In most cases, Tasks will have an intent of "order".

Data type

Binding

Distinguishes whether the task is a proposal, plan or full order.

TaskIntent (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.intent
w5: FiveWs.class
rim: .moodCode

priority

0..1

codeBinding

There are no (further) constraints on this element

Element id

Task.priority

Short description

routine | urgent | asap | stat

Definition

Indicates how quickly the Task should be addressed with respect to other requests.

Requirements

Used to identify the service level expected while performing a task.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If missing, this task should be performed with normal priority

Data type

Binding

The task's priority.

RequestPriority (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.priority
w5: FiveWs.grade
rim: .priorityCode

code

0..1

There are no (further) constraints on this element

Element id

Task.code

Short description

Task Type

Definition

A name or code (or both) briefly describing what the task involves.

Comments

The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.

Data type

Binding

Codes to identify what the task involves. These will typically be specific to a particular workflow.

TaskCode (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code, Event.code
w5: FiveWs.what[x]
rim: .code

description

0..1

Element id

Task.description

Short description

Human-readable explanation of task

Definition

A free-text description of what is to be performed. Implementers should ensure the text is readable on mobile applications.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .text

focus

Σ C

0..1

There are no (further) constraints on this element

Element id

Task.focus

Short description

What task is acting on

Definition

The request being actioned or the resource being manipulated by this task.

Requirements

Used to identify the thing to be done.

Comments

If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.what[x]
rim: .outboundRelationship[typeCode=SUBJ].target

for

Σ C

1..1

Reference(http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient)

Element id

Task.for

Short description

Beneficiary of the Task

Alternate names

Patient

Definition

The patient who benefits from the performance of the service specified in the task.

Requirements

Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control.

Comments

In this profile, this element always refers to the patient for whom the task is intended.

Data type

Reference(http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.subject, Event.subject
w5: FiveWs.subject[x]
rim: .participation[typeCode=RCT].role
w5: FiveWs.subject

encounter

Σ C

0..1

Reference(Encounter)

There are no (further) constraints on this element

Element id

Task.encounter

Short description

Healthcare event during which this task originated

Definition

The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.

Requirements

For some tasks it may be important to know the link between the encounter the task originated within.

Comments

Data type

Reference(Encounter)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.context, Event.context
w5: FiveWs.context
rim: .inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]

executionPeriod

Σ C

0..1

There are no (further) constraints on this element

Element id

Task.executionPeriod

Short description

Start and end time of execution

Definition

Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).

Comments

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
workflow: Event.occurrence[x]
w5: FiveWs.done[x]
rim: .effectiveTime

authoredOn

0..1

There are no (further) constraints on this element

Element id

Task.authoredOn

Short description

Task Creation Date

Alternate names

Created Date

Definition

The date and time this task was created.

Requirements

Most often used along with lastUpdated to track duration of task to supporting monitoring and management.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.authoredOn
w5: FiveWs.recorded
rim: .participation[typeCode=AUT].time

lastModified

Σ C

0..1

There are no (further) constraints on this element

Element id

Task.lastModified

Short description

Task Last Modified Date

Alternate names

Update Date

Definition

The date and time of last modification to this task.

Requirements

Used along with history to track task activity and time in a particular task state. This enables monitoring and management.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime

requester

Σ C

0..1

Element id

Task.requester

Short description

Who is asking for task to be done

Definition

In Koppeltaal this element contains a reference to the person requesting the eHealth Task

Requirements

Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).

Comments

Each occurrence of the zib HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of nl-core-HealthProfessional-PractitionerRole) and a Practitioner resource (instance of nl-core-HealthProfessional-Practitioner). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.

In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the nl-core-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.requester
w5: FiveWs.author
rim: .participation[typeCode=AUT].role

performerType

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Task.performerType

Short description

Requested performer

Definition

The kind of participant that should perform the task.

Requirements

Use to distinguish tasks on different activity queues.

Comments

Data type

ProcedurePerformerRoleCodes (preferred)

Binding

The type(s) of task performers allowed.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.performer.role, Request.performerType
w5: FiveWs.actor
rim: .participation[typeCode=PRF].role.code

owner

Σ C

1..1

Element id

Task.owner

Short description

Responsible individual

Alternate names

Performer, Executer

Definition

Practitioner, CareTeam, RelatedPerson or Patient currently responsible for task execution.

Requirements

Identifies who is expected to perform this task.

Comments

For Koppeltaal: In Koppeltaal the patient is usually the person who executes the task. Note, this element is not intended to be used for access restriction. That is left to the relevant applications.

Each occurrence of the zib HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of nl-core-HealthProfessional-PractitionerRole) and a Practitioner resource (instance of nl-core-HealthProfessional-Practitioner). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.

In ProviderTasks, the owner is typically the performer of the task (usually the patient), but execution may also be delegated to another responsible party such as a caregiver/contact person or a care team.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.performer.actor, Request.performer
w5: FiveWs.actor
rim: .participation[typeCode=PRF].role

location

Σ C

0..1

There are no (further) constraints on this element

Element id

Task.location

Short description

Where task occurs

Definition

Principal physical location where the this task is performed.

Requirements

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).

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonCode, Event.reasonCode
w5: FiveWs.where[x]
rim: .participation[typeCode=LOC].role

reasonCode

0..1

There are no (further) constraints on this element

Element id

Task.reasonCode

Short description

Why task is needed

Definition

A description or code indicating why this task needs to be performed.

Comments

This should only be included if there is no focus or if it differs from the reason indicated on the focus.

Data type

Binding

Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.location
w5: FiveWs.why[x]
v2: EVN.7
rim: .reasonCode

reasonReference

0..1

There are no (further) constraints on this element

Element id

Task.reasonReference

Short description

Why task is needed

Definition

A resource reference indicating why this task needs to be performed.

Comments

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 Task.reasonCode if the data is free (uncoded) text.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference, Event.reasonReference
w5: FiveWs.why[x]
rim: .outboundRelationship[typeCode=RSON].target

insurance

0..*

Reference(ClaimResponse | Coverage)

There are no (further) constraints on this element

Element id

Task.insurance

Short description

Associated insurance coverage

Definition

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.

Comments

Data type

Reference(ClaimResponse | Coverage)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.insurance
v2: IN1/IN2
rim: .outboundRelationship[typeCode=COVBY].target

note

0..*

There are no (further) constraints on this element

Element id

Task.note

Short description

Comments made about the task

Definition

Free-text information captured about the task as it progresses.

Comments

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).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Request.note, Event.note
rim: .inboundRelationship[typeCode=SUBJ, ].source[classCode=OBS, moodCode=EVN, code="annotation"].value(string)

relevantHistory

0..*

Reference(Provenance)

There are no (further) constraints on this element

Element id

Task.relevantHistory

Short description

Key events in history of the Task

Alternate names

Status History

Definition

Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.

Comments

This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.

Data type

Reference(Provenance)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.relevantHistory
rim: .inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]

restriction

0..1

There are no (further) constraints on this element

Element id

Task.restriction

Short description

Constraints on fulfillment tasks

Definition

If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.

Requirements

Sometimes when fulfillment is sought, you don't want full fulfillment.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: Instead of pointing to request, would point to component of request, having these characteristics

0..1

There are no (further) constraints on this element

Element id

Task.restriction.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Task.restriction.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May 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.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Task.restriction.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

repetitions

0..1

There are no (further) constraints on this element

Element id

Task.restriction.repetitions

Short description

How many times to repeat

Definition

Indicates the number of times the requested action should occur.

Requirements

E.g. order that requests monthly lab tests, fulfillment is sought for 1.

Comments

32 bit number; for values larger than this, use decimal

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .repeatNumber

period

0..1

There are no (further) constraints on this element

Element id

Task.restriction.period

Short description

When fulfillment sought

Definition

Over what time-period is fulfillment sought.

Requirements

E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.

Comments

Note that period.high is the due date representing the time by which the task should be completed.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
rim: .effectiveTime(IVL<TS>)

recipient

0..*

There are no (further) constraints on this element

Element id

Task.restriction.recipient

Short description

For whom is fulfillment sought?

Definition

For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .participation[typeCode=SBJ].role

input

0..*

There are no (further) constraints on this element

Element id

Task.input

Short description

Information used to perform task

Alternate names

Supporting Information

Definition

Additional information that may be needed in the execution of the task.

Requirements

Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ???

0..1

There are no (further) constraints on this element

Element id

Task.input.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Task.input.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Task.input.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

type

1..1

There are no (further) constraints on this element

Element id

Task.input.type

Short description

Label for the input

Alternate names

Name

Definition

A code or description indicating how the input is intended to be used as part of the task execution.

Requirements

Inputs are named to enable task automation to bind data and pass it from one task to the next.

Comments

If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.

Data type

Binding

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.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ???

value[x]

1..1

There are no (further) constraints on this element

Element id

Task.input.value[x]

Short description

Content to use in performing the task

Definition

The value of the input parameter as a basic type.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ???

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

output

0..*

There are no (further) constraints on this element

Element id

Task.output

Short description

Information produced as part of task

Definition

Outputs produced by the Task.

Requirements

Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ???

0..1

There are no (further) constraints on this element

Element id

Task.output.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Task.output.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Task.output.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

type

1..1

There are no (further) constraints on this element

Element id

Task.output.type

Short description

Label for output

Alternate names

Name

Definition

The name of the Output parameter.

Requirements

Outputs are named to enable task automation to bind data and pass it from one task to the next.

Comments

Data type

Binding

Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: ???

value[x]

1..1

There are no (further) constraints on this element

Element id

Task.output.value[x]

Short description

Result of output

Definition

The value of the Output parameter as a basic type.

Requirements

Task outputs can take any form.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: ???

valueAddress

There are no (further) constraints on this element

Data type

valueAge

There are no (further) constraints on this element

Data type

valueAnnotation

There are no (further) constraints on this element

Data type

valueAttachment

There are no (further) constraints on this element

Data type

valueBase64Binary

There are no (further) constraints on this element

Data type

valueBoolean

There are no (further) constraints on this element

Data type

valueCanonical

There are no (further) constraints on this element

Data type

valueCode

There are no (further) constraints on this element

Data type

valueCodeableConcept

There are no (further) constraints on this element

Data type

valueCoding

There are no (further) constraints on this element

Data type

valueContactDetail

There are no (further) constraints on this element

Data type

valueContactPoint

There are no (further) constraints on this element

Data type

valueContributor

There are no (further) constraints on this element

Data type

valueCount

There are no (further) constraints on this element

Data type

valueDataRequirement

There are no (further) constraints on this element

Data type

valueDate

There are no (further) constraints on this element

Data type

valueDateTime

There are no (further) constraints on this element

Data type

valueDecimal

There are no (further) constraints on this element

Data type

valueDistance

There are no (further) constraints on this element

Data type

valueDosage

There are no (further) constraints on this element

Data type

valueDuration

There are no (further) constraints on this element

Data type

valueExpression

There are no (further) constraints on this element

Data type

valueHumanName

There are no (further) constraints on this element

Data type

valueId

There are no (further) constraints on this element

Data type

valueIdentifier

There are no (further) constraints on this element

Data type

valueInstant

There are no (further) constraints on this element

Data type

valueInteger

There are no (further) constraints on this element

Data type

valueMarkdown

There are no (further) constraints on this element

Data type

valueMeta

There are no (further) constraints on this element

Data type

valueMoney

There are no (further) constraints on this element

Data type

valueOid

There are no (further) constraints on this element

Data type

valueParameterDefinition

There are no (further) constraints on this element

Data type

valuePeriod

There are no (further) constraints on this element

Data type

valuePositiveInt

There are no (further) constraints on this element

Data type

valueQuantity

There are no (further) constraints on this element

Data type

valueRange

There are no (further) constraints on this element

Data type

valueRatio

There are no (further) constraints on this element

Data type

valueReference

There are no (further) constraints on this element

Data type

valueRelatedArtifact

There are no (further) constraints on this element

Data type

valueSampledData

There are no (further) constraints on this element

Data type

valueSignature

There are no (further) constraints on this element

Data type

valueString

There are no (further) constraints on this element

Data type

valueTime

There are no (further) constraints on this element

Data type

valueTiming

There are no (further) constraints on this element

Data type

valueTriggerDefinition

There are no (further) constraints on this element

Data type

valueUnsignedInt

There are no (further) constraints on this element

Data type

valueUri

There are no (further) constraints on this element

Data type

valueUrl

There are no (further) constraints on this element

Data type

valueUsageContext

There are no (further) constraints on this element

Data type

valueUuid

There are no (further) constraints on this element

Data type

<id value="pt-Task" />
<text>
<status value="empty" />

--- We have skipped the narrative for better readability of the resource ---
</text>
<url value="http://medmij.nl/fhir/StructureDefinition/pt-Task" />
<name value="ProviderTasksTask" />
<status value="draft" />
<publisher value="MedMij" />
<contact>
<name value="MedMij" />
<telecom>
<system value="email" />
<value value="info@medmij.nl" />
<use value="work" />
</telecom>
</contact>
<description value="This (FHIR) Task profile describes a patient-specific actionable item, intended to be presented to the patient in a client application (e.g., a PGO) and/or processed within the Koppeltaal workflow. It may optionally reference an ActivityDefinition that defines what should be launched or performed (module, questionnaire, information, measurement)." />
<purpose value="This profile represents a patient-specific actionable item, intended to be presented to the patient in a client application (e.g., a PGO) and/or processed in the Koppeltaal workflow, optionally instantiating an ActivityDefinition that can be launched or performed (module, questionnaire, information, measurement)." />
<copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Task" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Task" />
<derivation value="constraint" />
<differential>
<element id="Task">
<path value="Task" />
<short value="Task" />
<definition value="A patient-specific actionable item, assigned to the patient and optionally linked to an ActivityDefinition describing what to launch or perform." />
<alias value="Taak" />
</element>
<element id="Task.extension">
<path value="Task.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
<short value="Reference to ActivityDefinition" />
<definition value="A link to the ActivityDefinition that defines the launchable eHealth activity (i.e., what module/content should be launched or performed) associated with this Task. In both MedMij and Koppeltaal implementations, this link is carried using the Koppeltaal instantiates extension." />
</element>
<element id="Task.extension.extension">
<path value="Task.extension.extension" />
<max value="0" />
</element>
<element id="Task.extension.value[x]">
<path value="Task.extension.value[x]" />
<slicing>
<discriminator>
<type value="type" />
<path value="$this" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="Task.extension.value[x]:valueReference">
<path value="Task.extension.value[x]" />
<sliceName value="valueReference" />
<min value="0" />
<max value="1" />
<type>
<code value="Reference" />
<targetProfile value="http://medmij.nl/fhir/StructureDefinition/pt-ActivityDefinition" />
</type>
</element>
<element id="Task.extension:resource-origin">
<path value="Task.extension" />
<sliceName value="resource-origin" />
<min value="0" />
<max value="*" />
<type>
<code value="Extension" />
<profile value="http://koppeltaal.nl/fhir/StructureDefinition/resource-origin" />
</type>
</element>
<element id="Task.extension:instantiates">
<path value="Task.extension" />
<sliceName value="instantiates" />
<min value="0" />
<max value="*" />
<type>
<code value="Extension" />
<profile value="http://vzvz.nl/fhir/StructureDefinition/instantiates" />
</type>
</element>
<element id="Task.identifier">
<path value="Task.identifier" />
<min value="1" />
</element>
<element id="Task.groupIdentifier">
<path value="Task.groupIdentifier" />
<definition value="An identifier that links together multiple tasks and other requests that were created in the same context. The groupIdentifier (system/value pair) can be used to group and filter related Tasks (e.g., all tasks belonging to the same digital activity or workflow package). In this profile, groupIdentifier.type.text is used to provide a human-readable group label for display in the PGO." />
</element>
<element id="Task.partOf">
<path value="Task.partOf" />
<type>
<code value="Reference" />
<targetProfile value="http://medmij.nl/fhir/StructureDefinition/pt-Task" />
</type>
</element>
<element id="Task.description">
<path value="Task.description" />
<definition value="A free-text description of what is to be performed. Implementers should ensure the text is readable on mobile applications." />
</element>
<element id="Task.for">
<path value="Task.for" />
<definition value="The patient who benefits from the performance of the service specified in the task." />
<comment value="In this profile, this element always refers to the patient for whom the task is intended." />
<requirements value="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." />
<min value="1" />
<type>
<code value="Reference" />
<targetProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient" />
</type>
</element>
<element id="Task.requester">
<path value="Task.requester" />
<definition value="In Koppeltaal this element contains a reference to the person requesting the eHealth Task" />
<comment value="Each occurrence of the zib HealthProfessional is normally represented by _two_ FHIR resources: a PractitionerRole resource (instance of [nl-core-HealthProfessional-PractitionerRole](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole)) and a Practitioner resource (instance of [nl-core-HealthProfessional-Practitioner](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner)). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.\n\nIn rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the nl-core-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile." />
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
<targetProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole" />
</type>
</element>
<element id="Task.owner">
<path value="Task.owner" />
<definition value="Practitioner, CareTeam, RelatedPerson or Patient currently responsible for task execution." />
<comment value="For Koppeltaal: In Koppeltaal the patient is usually the person who executes the task. Note, this element is not intended to be used for access restriction. That is left to the relevant applications.\n\nEach occurrence of the zib HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of [nl-core-HealthProfessional-PractitionerRole](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole)) and a Practitioner resource (instance of [nl-core-HealthProfessional-Practitioner](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner)). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.\n\nIn rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the nl-core-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile.\n\n In ProviderTasks, the owner is typically the performer of the task (usually the patient), but execution may also be delegated to another responsible party such as a caregiver/contact person or a care team." />
<min value="1" />
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/HealthcareService" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
<targetProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-CareTeam" />
<targetProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient" />
<targetProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole" />
<targetProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactPerson" />
</type>
</element>
</differential>

</StructureDefinition>

{

"resourceType": "StructureDefinition",
"id": "pt-Task",
"text": {
"status": "empty",

--- We have skipped the narrative for better readability of the resource ---
},
"url": "http://medmij.nl/fhir/StructureDefinition/pt-Task",
"name": "ProviderTasksTask",
"status": "draft",
"publisher": "MedMij",
"contact": [
{
"name": "MedMij",
"telecom": [
{
"system": "email",
"value": "info@medmij.nl",
"use": "work"
}
]
}
],
"description": "This (FHIR) Task profile describes a patient-specific actionable item, intended to be presented to the patient in a client application (e.g., a PGO) and/or processed within the Koppeltaal workflow. It may optionally reference an ActivityDefinition that defines what should be launched or performed (module, questionnaire, information, measurement).",
"purpose": "This profile represents a patient-specific actionable item, intended to be presented to the patient in a client application (e.g., a PGO) and/or processed in the Koppeltaal workflow, optionally instantiating an ActivityDefinition that can be launched or performed (module, questionnaire, information, measurement).",
"copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Task",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Task",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Task",
"path": "Task",
"short": "Task",
"definition": "A patient-specific actionable item, assigned to the patient and optionally linked to an ActivityDefinition describing what to launch or perform.",
"alias": [
"Taak"
]
},
{
"id": "Task.extension",
"path": "Task.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Reference to ActivityDefinition",
"definition": "A link to the ActivityDefinition that defines the launchable eHealth activity (i.e., what module/content should be launched or performed) associated with this Task. In both MedMij and Koppeltaal implementations, this link is carried using the Koppeltaal instantiates extension."
},
{
"id": "Task.extension.extension",
"path": "Task.extension.extension",
"max": "0"
},
{
"id": "Task.extension.value[x]",
"path": "Task.extension.value[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "Task.extension.value[x]:valueReference",
"path": "Task.extension.value[x]",
"sliceName": "valueReference",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://medmij.nl/fhir/StructureDefinition/pt-ActivityDefinition"
]
}
]
},
{
"id": "Task.extension:resource-origin",
"path": "Task.extension",
"sliceName": "resource-origin",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension",
"profile": [
"http://koppeltaal.nl/fhir/StructureDefinition/resource-origin"
]
}
]
},
{
"id": "Task.extension:instantiates",
"path": "Task.extension",
"sliceName": "instantiates",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension",
"profile": [
"http://vzvz.nl/fhir/StructureDefinition/instantiates"
]
}
]
},
{
"id": "Task.identifier",
"path": "Task.identifier",
"min": 1
},
{
"id": "Task.groupIdentifier",
"path": "Task.groupIdentifier",
"definition": "An identifier that links together multiple tasks and other requests that were created in the same context. The groupIdentifier (system/value pair) can be used to group and filter related Tasks (e.g., all tasks belonging to the same digital activity or workflow package). In this profile, groupIdentifier.type.text is used to provide a human-readable group label for display in the PGO."
},
{
"id": "Task.partOf",
"path": "Task.partOf",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://medmij.nl/fhir/StructureDefinition/pt-Task"
]
}
]
},
{
"id": "Task.description",
"path": "Task.description",
"definition": "A free-text description of what is to be performed. Implementers should ensure the text is readable on mobile applications."
},
{
"id": "Task.for",
"path": "Task.for",
"definition": "The patient who benefits from the performance of the service specified in the task.",
"comment": "In this profile, this element always refers to the patient for whom the task is intended.",
"requirements": "Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control.",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": [
"http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient"
]
}
]
},
{
"id": "Task.requester",
"path": "Task.requester",
"definition": "In Koppeltaal this element contains a reference to the person requesting the eHealth Task",
"comment": "Each occurrence of the zib HealthProfessional is normally represented by _two_ FHIR resources: a PractitionerRole resource (instance of [nl-core-HealthProfessional-PractitionerRole](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole)) and a Practitioner resource (instance of [nl-core-HealthProfessional-Practitioner](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner)). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.\n\nIn rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the nl-core-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile.",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole"
]
}
]
},
{
"id": "Task.owner",
"path": "Task.owner",
"definition": "Practitioner, CareTeam, RelatedPerson or Patient currently responsible for task execution.",
"comment": "For Koppeltaal: In Koppeltaal the patient is usually the person who executes the task. Note, this element is not intended to be used for access restriction. That is left to the relevant applications.\n\nEach occurrence of the zib HealthProfessional is normally represented by two FHIR resources: a PractitionerRole resource (instance of [nl-core-HealthProfessional-PractitionerRole](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole)) and a Practitioner resource (instance of [nl-core-HealthProfessional-Practitioner](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner)). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.\n\nIn rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the nl-core-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile.\n\n In ProviderTasks, the owner is typically the performer of the task (usually the patient), but execution may also be delegated to another responsible party such as a caregiver/contact person or a care team.",
"min": 1,
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/CareTeam",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-CareTeam",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactPerson"
]
}
]
}
]
}

}

3.2.2. Report

ProviderTasksActivityDefinition (ActivityDefinition)

ActivityDefinition

Element id

ActivityDefinition

Short description

The definition of a specific activity to be taken, independent of any particular patient or context

Definition

Definition of a launchable digital (eHealth) activity that can be used as a template for patient-specific workflow requests. The definition may describe different activity types (e.g., launching a third-party module, presenting information, completing a questionnaire, or performing a measurement) and includes the technical launch details needed to invoke the activity in the correct context.

Data type

ActivityDefinition

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
adf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Mappings

rim: Entity. Role, or Act
workflow: Definition
rim: Act[classCode=ACT; moodCode=DEFN]

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.id

Short description

Logical id of this artifact

Definition

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

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.meta

Short description

Metadata about the resource

Definition

The 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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

ActivityDefinition.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

text

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

1..*

Element id

ActivityDefinition.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

resource-origin

0..*

Element id

ActivityDefinition.extension:resource-origin

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension URL

http://koppeltaal.nl/fhir/StructureDefinition/resource-origin

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

endpoint

1..*

Element id

ActivityDefinition.extension:endpoint

Short description

Endpoint for launching the activity

Alternate names

extensions, user content

Definition

Mandatory reference to the service application (endpoint) that provides the launchable eHealth activity. Can be more than one endpoint.

Comments

Data type

Extension URL

http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

publisherId

0..*

Element id

ActivityDefinition.extension:publisherId

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension URL

http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.url

Short description

Canonical identifier for this activity definition, represented as a URI (globally unique)

Definition

An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.

Requirements

Allows the activity definition to be referenced by a single globally unique identifier.

Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.url
w5: FiveWs.identifier
rim: .identifier[scope=BUSN;reliability=ISS]

identifier

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.identifier

Short description

Additional identifier for the activity definition

Definition

A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Definition.identifier
w5: FiveWs.identifier
rim: .identifier
objimpl: no-gen-base

version

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.version

Short description

Business version of the activity definition

Definition

The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.

Comments

There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the activity definition with the format [url]|[version].

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.version
w5: FiveWs.version
rim: N/A (to add?)

name

Σ C

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.name

Short description

Name for this activity definition (computer friendly)

Definition

A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Requirements

Support human navigation and code generation.

Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, inv-0

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

title

1..1

There are no (further) constraints on this element

Element id

ActivityDefinition.title

Short description

Name for this activity definition (human friendly)

Definition

A short, descriptive, user-friendly title for the activity definition.

Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.title
rim: .title

subtitle

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.subtitle

Short description

Subordinate title of the activity definition

Definition

An explanatory or alternate title for the activity definition giving additional information about its content.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

status

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

ActivityDefinition.status

Short description

draft | active | retired | unknown

Definition

The status of this activity definition. Enables tracking the life-cycle of the content.

Comments

Allows filtering of activity definitions that are appropriate for use versus not.

Data type

Binding

The lifecycle status of an artifact.

PublicationStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.status {different ValueSet}
w5: FiveWs.status
rim: .status

experimental

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.experimental

Short description

For testing purposes, not real usage

Definition

A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition.

Comments

Allows filtering of activity definitions that are appropriate for use versus not.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.experimental
w5: FiveWs.class
rim: N/A (to add?)

subject[x]

0..1

Binding

There are no (further) constraints on this element

Element id

ActivityDefinition.subject[x]

Short description

Type of individual the activity definition is intended for

Definition

A code or group definition that describes the intended subject of the activity being defined.

Meaning when missing

Patient

Binding

The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).

SubjectType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.subject

subjectCodeableConcept

There are no (further) constraints on this element

Data type

subjectReference

Reference(Group)

There are no (further) constraints on this element

Data type

Reference(Group)

date

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.date

Short description

Date last changed

Alternate names

Revision Date

Definition

The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.

Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.date
w5: FiveWs.recorded
rim: .participation[typeCode=AUT].time

publisher

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.publisher

Short description

Name of the publisher (organization or individual)

Definition

The name of the organization or individual that published the activity definition.

Requirements

Helps establish the "authority/credibility" of the activity definition. May also allow for contact.

Comments

Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the activity definition. This item SHOULD be populated unless the information is available from context.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.publisher {as string instead of CodeableConcept}
w5: FiveWs.witness
rim: .participation[typeCode=AUT].role

contact

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.contact

Short description

Contact details for the publisher

Definition

Contact details to assist a user in finding and communicating with the publisher.

Comments

May be a web site, an email address, a telephone number, etc.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.contact
rim: .participation[typeCode=CALLBCK].role

description

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.description

Short description

Natural language description of the activity definition

Definition

A free text natural language description of the activity definition from a consumer's perspective.

Comments

This description can be used to capture details such as why the activity definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the activity definition is presumed to be the predominant language in the place the activity definition was created).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.description
rim: .text

useContext

0..*

Element id

ActivityDefinition.useContext

Short description

The context that the content is intended to support

Definition

The context for the content of the eHealth activity.

Requirements

Assist in searching for appropriate content.

Comments

E.g. the activity is targeted to a certain age group.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.useContext
rim: N/A (to add?)

jurisdiction

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

ActivityDefinition.jurisdiction

Short description

Intended jurisdiction for activity definition (if applicable)

Definition

A legal or geographic region in which the activity definition is intended to be used.

Comments

It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended.

Data type

Jurisdiction ValueSet (extensible)

Binding

Countries and regions within which this artifact is targeted for use.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Definition.jurisdiction
rim: N/A (to add?)

purpose

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.purpose

Short description

Why this activity definition is defined

Definition

Explanation of why this activity definition is needed and why it has been designed as it has.

Comments

This element does not describe the usage of the activity definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.purpose
w5: FiveWs.why[x]
rim: .reasonCode.text
objimpl: no-gen-base

usage

0..1

Element id

ActivityDefinition.usage

Short description

Describes the clinical usage of the activity definition

Definition

A detailed description of how the activity definition is used from a clinical perspective. In the MedMij use case, this text is intended for the healthcare professional who is selecting and assigning the activity to the patient.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A (to add?)

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.copyright

Short description

Use and/or publishing restrictions

Alternate names

License, Restrictions

Definition

A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.

Requirements

Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content.

Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.copyright
rim: N/A (to add?)
objimpl: no-gen-base

approvalDate

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.approvalDate

Short description

When the activity definition was approved by publisher

Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.approvalDate
rim: .outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime
objimpl: no-gen-base

lastReviewDate

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.lastReviewDate

Short description

When the activity definition was last reviewed

Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this date follows the original approval date.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Definition.lastReviewDate
rim: .outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime
objimpl: no-gen-base

effectivePeriod

Σ C

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.effectivePeriod

Short description

When the activity definition is expected to be used

Definition

The period during which the activity definition content was or is planned to be in active use.

Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the activity definition are or are expected to be used instead.

Comments

The effective period for a activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
workflow: Definition.effectivePeriod
rim: N/A (to add?)
objimpl: no-gen-base

topic

0..*

CodeableConceptBinding

Element id

ActivityDefinition.topic

Short description

E.g. Self-Treatment and Self-Assessment, etc.

Definition

Descriptive topics related to the content of the activity. The topic is used to indicate that the activity is intended or suitable for initialization by patients.

Requirements

Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches.

Comments

Data type

http://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topic (extensible)

Binding

High-level categorization of the definition, used for indicating special patient initialised activities

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: N/A (to add?)

author

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.author

Short description

Who authored the content

Definition

An individiual or organization primarily involved in the creation and maintenance of the content.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .participation[typeCode=AUT]

editor

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.editor

Short description

Who edited the content

Definition

An individual or organization primarily responsible for internal coherence of the content.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

reviewer

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.reviewer

Short description

Who reviewed the content

Definition

An individual or organization primarily responsible for review of some aspect of the content.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}

endorser

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.endorser

Short description

Who endorsed the content

Definition

An individual or organization responsible for officially endorsing the content for use in some setting.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}

relatedArtifact

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.relatedArtifact

Short description

Additional documentation, citations, etc.

Definition

Related artifacts such as additional documentation, justification, or bibliographic references.

Requirements

Activity definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=DOC,RSON,PREV, DRIV, USE, COMP] {successor would be PREV w/ inversionInd=true; No support for citation}

library

0..*

canonical(Library)

There are no (further) constraints on this element

Element id

ActivityDefinition.library

Short description

Logic used by the activity definition

Definition

A reference to a Library resource containing any formal logic used by the activity definition.

Comments

see Canonical References

Data type

canonical(Library)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=USE].target[classCode=GROUPER,moodCode=EVN]

kind

0..1

codeBinding

There are no (further) constraints on this element

Element id

ActivityDefinition.kind

Short description

Kind of resource

Definition

A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.

Comments

May determine what types of extensions are permitted.

Data type

RequestResourceType (required)

Binding

The kind of activity the definition is describing.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .classCode

profile

0..1

canonical(StructureDefinition)

There are no (further) constraints on this element

Element id

ActivityDefinition.profile

Short description

What profile the resource needs to conform to

Definition

A profile to which the target of the activity definition is expected to conform.

Requirements

Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set.

Comments

see Canonical References

Data type

canonical(StructureDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

code

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.code

Short description

Detail type of activity

Definition

Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

Requirements

Allows matching performed to planned as well as validation against protocols.

Comments

Tends to be less relevant for activities involving particular products.

Data type

ProcedureCodes(SNOMEDCT) (example)

Binding

Detailed type of the activity; e.g. CBC.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .code

intent

0..1

codeBinding

There are no (further) constraints on this element

Element id

ActivityDefinition.intent

Short description

Definition

Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Binding

Codes indicating the degree of authority/intentionality associated with a request.

RequestIntent (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

priority

0..1

codeBinding

There are no (further) constraints on this element

Element id

ActivityDefinition.priority

Short description

routine | urgent | asap | stat

Definition

Indicates how quickly the activity should be addressed with respect to other requests.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Binding

Identifies the level of importance to be assigned to actioning the request.

RequestPriority (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

doNotPerform

Σ ?!

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.doNotPerform

Short description

True if the activity should not be performed

Definition

Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.

Comments

This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestGroup.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

timing[x]

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.timing[x]

Short description

When activity is to occur

Definition

The period, timing or frequency upon which the described activity is to occur.

Requirements

Allows prompting for activities and detection of missed planned activities.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .effectiveTime

timingAge

There are no (further) constraints on this element

Data type

timingDateTime

There are no (further) constraints on this element

Data type

timingDuration

There are no (further) constraints on this element

Data type

timingPeriod

There are no (further) constraints on this element

Data type

timingRange

There are no (further) constraints on this element

Data type

timingTiming

There are no (further) constraints on this element

Data type

location

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.location

Short description

Where it should happen

Alternate names

facility

Definition

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

Requirements

Helps in planning of activity.

Comments

May reference a specific clinical location or may just identify a type of location.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .participation[typeCode=LOC].role

participant

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.participant

Short description

Who should participate in the action

Definition

Indicates who should participate in performing the action described.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .participation[typeCode=PFM]

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.participant.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.participant.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.participant.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

type

1..1

codeBinding

There are no (further) constraints on this element

Element id

ActivityDefinition.participant.type

Short description

patient | practitioner | related-person | device

Definition

The type of participant in the action.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ActionParticipantType (required)

Binding

The type of participant in the activity.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .role.classCode

role

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.participant.role

Short description

E.g. Nurse, Surgeon, Parent, etc.

Definition

The role the participant should play in performing the described action.

Comments

Data type

ActionParticipantRole (example)

Binding

Defines roles played by participants for the action.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .role.code

product[x]

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.product[x]

Short description

What's administered/supplied

Definition

Identifies the food, drug or other product being consumed or supplied in the activity.

Binding

Code describing the type of substance or medication.

SNOMEDCTMedicationCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .participation[typeCode=CSM].role

productCodeableConcept

There are no (further) constraints on this element

Data type

productReference

Reference(Medication | Substance)

There are no (further) constraints on this element

Data type

Reference(Medication | Substance)

quantity

0..1

SimpleQuantity

There are no (further) constraints on this element

Element id

ActivityDefinition.quantity

Short description

How much is administered/consumed/supplied

Alternate names

dose

Definition

Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

SimpleQuantity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
rim: .quantity {for classCode=SPLY}

dosage

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.dosage

Short description

Detailed dosage instructions

Definition

Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.

Comments

If a dosage instruction is used, the definition should not specify timing or quantity.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]
rim: .outboundRelationship[typeCode=COMP].target[classCode=SBADM; moodCode=DEFN]

bodySite

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.bodySite

Short description

What part of body to perform on

Definition

Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).

Requirements

Knowing where the procedure is made is important for tracking if multiple sites are possible.

Comments

Only used if not implicit in the code found in ServiceRequest.type.

Data type

SNOMEDCTBodyStructures (example)

Binding

A code that identifies the anatomical location.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .targetSiteCode {for classCode=PROC, SBADM}

specimenRequirement

0..*

Reference(SpecimenDefinition)

There are no (further) constraints on this element

Element id

ActivityDefinition.specimenRequirement

Short description

What specimens are required to perform this action

Definition

Defines specimen requirements for the action to be performed, such as required specimens for a lab test.

Requirements

Needed to represent lab order definitions.

Comments

Data type

Reference(SpecimenDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

observationRequirement

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.observationRequirement

Short description

What observations are required to perform this action

Definition

Defines observation requirements for the action to be performed, such as body weight or surface area.

Requirements

Needed to represent observation definitions.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

observationResultRequirement

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.observationResultRequirement

Short description

What observations must be produced by this action

Definition

Defines the observations that are expected to be produced by the action.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

transform

0..1

canonical(StructureMap)

There are no (further) constraints on this element

Element id

ActivityDefinition.transform

Short description

Transform to apply the template

Definition

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

Comments

Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.

Data type

canonical(StructureMap)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

dynamicValue

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.dynamicValue

Short description

Dynamic aspects of the definition

Definition

Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.

Comments

Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

0..1

There are no (further) constraints on this element

Element id

ActivityDefinition.dynamicValue.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.dynamicValue.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

ActivityDefinition.dynamicValue.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

path

1..1

There are no (further) constraints on this element

Element id

ActivityDefinition.dynamicValue.path

Short description

The path to the element to be set dynamically

Definition

The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).

Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

expression

1..1

There are no (further) constraints on this element

Element id

ActivityDefinition.dynamicValue.expression

Short description

An expression that provides the dynamic value for the customization

Definition

An expression specifying the value of the customized element.

Comments

The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
exp-1: An expression or a reference must be provided
expression.exists() or reference.exists()

Mappings

rim: n/a
rim: N/A

<id value="pt-ActivityDefinition" />
<url value="http://medmij.nl/fhir/StructureDefinition/pt-ActivityDefinition" />
<name value="ProviderTasksActivityDefinition" />
<status value="draft" />
<publisher value="MedMij" />
<contact>
<name value="MedMij" />
<telecom>
<system value="email" />
<value value="info@medmij.nl" />
<use value="work" />
</telecom>
</contact>
<description value="This (FHIR) ActivityDefinition profile describes a reusable definition of a launchable digital (eHealth) activity that can be requested for a patient in MedMij and/or Koppeltaal workflows. It captures the clinical intent and the technical launch information (e.g., endpoint) so that systems can consistently create patient-specific Tasks that reference this definition." />
<copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="ActivityDefinition" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/ActivityDefinition" />
<derivation value="constraint" />
<differential>
<element id="ActivityDefinition">
<path value="ActivityDefinition" />
<definition value="Definition of a launchable digital (eHealth) activity that can be used as a template for patient-specific workflow requests. The definition may describe different activity types (e.g., launching a third-party module, presenting information, completing a questionnaire, or performing a measurement) and includes the technical launch details needed to invoke the activity in the correct context." />
</element>
<element id="ActivityDefinition.extension">
<path value="ActivityDefinition.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
<min value="1" />
</element>
<element id="ActivityDefinition.extension:resource-origin">
<path value="ActivityDefinition.extension" />
<sliceName value="resource-origin" />
<min value="0" />
<max value="*" />
<type>
<code value="Extension" />
<profile value="http://koppeltaal.nl/fhir/StructureDefinition/resource-origin" />
</type>
</element>
<element id="ActivityDefinition.extension:endpoint">
<path value="ActivityDefinition.extension" />
<sliceName value="endpoint" />
<short value="Endpoint for launching the activity" />
<definition value="Mandatory reference to the service application (endpoint) that provides the launchable eHealth activity. Can be more than one endpoint." />
<min value="1" />
<max value="*" />
<type>
<code value="Extension" />
<profile value="http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension" />
</type>
</element>
<element id="ActivityDefinition.extension:publisherId">
<path value="ActivityDefinition.extension" />
<sliceName value="publisherId" />
<min value="0" />
<max value="*" />
<type>
<code value="Extension" />
<profile value="http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId" />
</type>
</element>
<element id="ActivityDefinition.title">
<path value="ActivityDefinition.title" />
<min value="1" />
</element>
<element id="ActivityDefinition.useContext">
<path value="ActivityDefinition.useContext" />
<definition value="The context for the content of the eHealth activity." />
<comment value="E.g. the activity is targeted to a certain age group." />
</element>
<element id="ActivityDefinition.usage">
<path value="ActivityDefinition.usage" />
<definition value="A detailed description of how the activity definition is used from a clinical perspective. In the MedMij use case, this text is intended for the healthcare professional who is selecting and assigning the activity to the patient." />
</element>
<element id="ActivityDefinition.topic">
<path value="ActivityDefinition.topic" />
<short value="E.g. Self-Treatment and Self-Assessment, etc." />
<definition value="Descriptive topics related to the content of the activity. The topic is used to indicate that the activity is intended or suitable for initialization by patients." />
<binding>
<strength value="extensible" />
<description value="High-level categorization of the definition, used for indicating special patient initialised activities" />
<valueSet value="http://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topic" />
</binding>
</element>
</differential>

</StructureDefinition>

{

"resourceType": "StructureDefinition",
"id": "pt-ActivityDefinition",
"url": "http://medmij.nl/fhir/StructureDefinition/pt-ActivityDefinition",
"name": "ProviderTasksActivityDefinition",
"status": "draft",
"publisher": "MedMij",
"contact": [
{
"name": "MedMij",
"telecom": [
{
"system": "email",
"value": "info@medmij.nl",
"use": "work"
}
]
}
],
"description": "This (FHIR) ActivityDefinition profile describes a reusable definition of a launchable digital (eHealth) activity that can be requested for a patient in MedMij and/or Koppeltaal workflows. It captures the clinical intent and the technical launch information (e.g., endpoint) so that systems can consistently create patient-specific Tasks that reference this definition.",
"copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "ActivityDefinition",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "ActivityDefinition",
"path": "ActivityDefinition",
"definition": "Definition of a launchable digital (eHealth) activity that can be used as a template for patient-specific workflow requests. The definition may describe different activity types (e.g., launching a third-party module, presenting information, completing a questionnaire, or performing a measurement) and includes the technical launch details needed to invoke the activity in the correct context."
},
{
"id": "ActivityDefinition.extension",
"path": "ActivityDefinition.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 1
},
{
"id": "ActivityDefinition.extension:resource-origin",
"path": "ActivityDefinition.extension",
"sliceName": "resource-origin",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension",
"profile": [
"http://koppeltaal.nl/fhir/StructureDefinition/resource-origin"
]
}
]
},
{
"id": "ActivityDefinition.extension:endpoint",
"path": "ActivityDefinition.extension",
"sliceName": "endpoint",
"short": "Endpoint for launching the activity",
"definition": "Mandatory reference to the service application (endpoint) that provides the launchable eHealth activity. Can be more than one endpoint.",
"min": 1,
"max": "*",
"type": [
{
"code": "Extension",
"profile": [
"http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension"
]
}
]
},
{
"id": "ActivityDefinition.extension:publisherId",
"path": "ActivityDefinition.extension",
"sliceName": "publisherId",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension",
"profile": [
"http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId"
]
}
]
},
{
"id": "ActivityDefinition.title",
"path": "ActivityDefinition.title",
"min": 1
},
{
"id": "ActivityDefinition.useContext",
"path": "ActivityDefinition.useContext",
"definition": "The context for the content of the eHealth activity.",
"comment": "E.g. the activity is targeted to a certain age group."
},
{
"id": "ActivityDefinition.usage",
"path": "ActivityDefinition.usage",
"definition": "A detailed description of how the activity definition is used from a clinical perspective. In the MedMij use case, this text is intended for the healthcare professional who is selecting and assigning the activity to the patient."
},
{
"id": "ActivityDefinition.topic",
"path": "ActivityDefinition.topic",
"short": "E.g. Self-Treatment and Self-Assessment, etc.",
"definition": "Descriptive topics related to the content of the activity. The topic is used to indicate that the activity is intended or suitable for initialization by patients.",
"binding": {
"strength": "extensible",
"description": "High-level categorization of the definition, used for indicating special patient initialised activities",
"valueSet": "http://vzvz.nl/fhir/ValueSet/koppeltaal-definition-topic"
}
}
]
}

}

3.2.3. Report

ProviderTasksEndpoint (Endpoint)

Endpoint

There are no (further) constraints on this element

Element id

Endpoint

Short description

The technical details of an endpoint that can be used for electronic services

Definition

The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.

Data type

Endpoint

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
rim: n/a

0..1

There are no (further) constraints on this element

Element id

Endpoint.id

Short description

Logical id of this artifact

Definition

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

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Endpoint.meta

Short description

Metadata about the resource

Definition

The 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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Endpoint.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Endpoint.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

text

0..1

There are no (further) constraints on this element

Element id

Endpoint.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

Endpoint.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Element id

Endpoint.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

resource-origin

0..1

Element id

Endpoint.extension:resource-origin

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://medmij.nl/fhir/StructureDefinition/ext-ClientID

Extension URL

http://koppeltaal.nl/fhir/StructureDefinition/resource-origin

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

clientId

0..1

Extension(string)

Element id

Endpoint.extension:clientId

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

The client ID from the Endpoint resource extension is used as an input parameter named “audience” in the token exchange request between PGO and the DVA authorisation server.

Comments

The purpose of client ID is to perform impersonation during token exchange, which results in a launch token of type: medmij:token-type:one-time-code and a smart_launch_context being stored in the DVA authorisation server for that client ID.

The launch token is used again as the value for the launch parameter in the SmartOnFhir launch URL.

The module application that receives the SmartOnFhir launch URL requests a new access token with the same client ID, including the launch token as an additional parameter from the DVA authorisation server, which includes the smart_launch_context in the final token response if both the launch token and client ID match.

Translated with DeepL.com (free version)

Data type

Extension(string)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Endpoint.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

Endpoint.identifier

Short description

Identifies this endpoint across multiple systems

Definition

Identifier for the organization that is used to identify the endpoint across multiple disparate systems.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier

status

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

Endpoint.status

Short description

Definition

active | suspended | error | off | test.

Comments

This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid.

Data type

Binding

The status of the endpoint.

EndpointStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.status

connectionType

1..1

CodingBinding

Element id

Endpoint.connectionType

Short description

Protocol/Profile/Standard to be used with this endpoint connection

Definition

A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).

Comments

For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.

Data type

http://vzvz.nl/fhir/ValueSet/endpoint-connection-type (extensible)

Binding

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
w5: FiveWs.class

name

0..1

There are no (further) constraints on this element

Element id

Endpoint.name

Short description

A name that this endpoint can be identified by

Definition

A friendly name that this endpoint can be referred to with.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
w5: FiveWs.what[x]

managingOrganization

Σ C

0..1

Reference(Organization | http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization)

Element id

Endpoint.managingOrganization

Short description

Organization that manages this endpoint (might not be the organization that exposes the endpoint)

Definition

The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data).

Comments

This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational hierarchy.

Data type

Reference(Organization | http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

contact

0..*

There are no (further) constraints on this element

Element id

Endpoint.contact

Short description

Contact details for source (e.g. troubleshooting)

Definition

Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
cpt-2: A system is required if a value is provided.
value.empty() or system.exists()

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Endpoint.period

Short description

Interval the endpoint is expected to be operational

Definition

The interval during which the endpoint is expected to be operational.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
w5: FiveWs.done[x]

payloadType

1..*

There are no (further) constraints on this element

Element id

Endpoint.payloadType

Short description

The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)

Definition

The payload type describes the acceptable content that can be communicated on the endpoint.

Comments

The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan.

Data type

Binding

EndpointPayloadType (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

payloadMimeType

0..*

codeBinding

There are no (further) constraints on this element

Element id

Endpoint.payloadMimeType

Short description

Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)

Definition

The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).

Comments

Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.

Data type

Binding

The mime type of an attachment. Any valid mime type is allowed.

Mime Types (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

address

1..1

There are no (further) constraints on this element

Element id

Endpoint.address

Short description

The technical base address for connecting to this endpoint

Definition

The uri that describes the actual end-point to connect to.

Comments

For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs)

This address will be to the service base, without any parameters, or sub-services or resources tacked on.

E.g. for a WADO-RS endpoint, the url should be "https://pacs.hospital.org/wado-rs"

and not "https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...".

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

header

0..*

There are no (further) constraints on this element

Element id

Endpoint.header

Short description

Usage depends on the channel type

Definition

Additional headers / information to send as part of the notification.

Comments

Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

<id value="pt-Endpoint" />
<url value="http://medmij.nl/fhir/StructureDefinition/pt-Endpoint" />
<name value="ProviderTasksEndpoint" />
<status value="draft" />
<publisher value="MedMij" />
<contact>
<name value="MedMij" />
<telecom>
<system value="email" />
<value value="info@medmij.nl" />
<use value="work" />
</telecom>
</contact>
<description value="This (FHIR) Endpoint profile represents the technical FHIR REST endpoint of a source system (XIS), used by a ProviderModule to retrieve and update task data and the required context for the ProviderModule use case." />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Endpoint" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Endpoint" />
<derivation value="constraint" />
<differential>
<element id="Endpoint.extension">
<path value="Endpoint.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="Endpoint.extension:resource-origin">
<path value="Endpoint.extension" />
<sliceName value="resource-origin" />
<min value="0" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="http://koppeltaal.nl/fhir/StructureDefinition/resource-origin" />
</type>
</element>
<element id="Endpoint.extension:clientId">
<path value="Endpoint.extension" />
<sliceName value="clientId" />
<min value="0" />
<max value="*" />
<type>
<code value="Extension" />
<profile value="http://medmij.nl/fhir/StructureDefinition/ext-ClientID" />
</type>
</element>
<element id="Endpoint.connectionType">
<path value="Endpoint.connectionType" />
<binding>
<strength value="extensible" />
<valueSet value="http://vzvz.nl/fhir/ValueSet/endpoint-connection-type" />
</binding>
</element>
<element id="Endpoint.managingOrganization">
<path value="Endpoint.managingOrganization" />
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
<targetProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization" />
</type>
</element>
</differential>

</StructureDefinition>

{

"resourceType": "StructureDefinition",
"id": "pt-Endpoint",
"url": "http://medmij.nl/fhir/StructureDefinition/pt-Endpoint",
"name": "ProviderTasksEndpoint",
"status": "draft",
"publisher": "MedMij",
"contact": [
{
"name": "MedMij",
"telecom": [
{
"system": "email",
"value": "info@medmij.nl",
"use": "work"
}
]
}
],
"description": "This (FHIR) Endpoint profile represents the technical FHIR REST endpoint of a source system (XIS), used by a ProviderModule to retrieve and update task data and the required context for the ProviderModule use case.",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Endpoint",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Endpoint",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Endpoint.extension",
"path": "Endpoint.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "Endpoint.extension:resource-origin",
"path": "Endpoint.extension",
"sliceName": "resource-origin",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://koppeltaal.nl/fhir/StructureDefinition/resource-origin"
]
}
]
},
{
"id": "Endpoint.extension:clientId",
"path": "Endpoint.extension",
"sliceName": "clientId",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension",
"profile": [
"http://medmij.nl/fhir/StructureDefinition/ext-ClientID"
]
}
]
},
{
"id": "Endpoint.connectionType",
"path": "Endpoint.connectionType",
"binding": {
"strength": "extensible",
"valueSet": "http://vzvz.nl/fhir/ValueSet/endpoint-connection-type"
}
},
{
"id": "Endpoint.managingOrganization",
"path": "Endpoint.managingOrganization",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization"
]
}
]
}
]
}

}

3.2.4. Report

ProviderTasksServiceRequest (ServiceRequest)

ServiceRequest

Element id

ServiceRequest

Short description

ServiceRequest

Alternate names

diagnostic request, referral, referral request, transfer of care request, Zorgopdracht

Definition

Patient-specific clinical order for requesting a digital (eHealth) activity in the ProviderTasks context. It links the patient, the requested activity definition, timing/schedule, and clinical rationale, and may include patient-specific instructions. It can be referenced by Task resources that coordinate execution and status tracking.

Data type

ServiceRequest

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
prr-1: orderDetail SHALL only be present if code is present
orderDetail.empty() or code.exists()

Mappings

rim: Entity. Role, or Act
workflow: Request
v2: ORC
rim: Act[moodCode<=INT]

0..1

There are no (further) constraints on this element

Element id

ServiceRequest.id

Short description

Logical id of this artifact

Definition

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

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

ServiceRequest.meta

Short description

Metadata about the resource

Definition

The 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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

ServiceRequest.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

ServiceRequest.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

text

0..1

There are no (further) constraints on this element

Element id

ServiceRequest.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

ServiceRequest.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Element id

ServiceRequest.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

resource-origin

0..*

Element id

ServiceRequest.extension:resource-origin

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension URL

http://koppeltaal.nl/fhir/StructureDefinition/resource-origin

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

ServiceRequest.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

ServiceRequest.identifier

Short description

Identifiers assigned to this order

Definition

Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

Comments

The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.identifier
w5: FiveWs.identifier
v2: ORC.2, ORC.3, RF1-6 / RF1-11,
rim: .identifier
quick: ClinicalStatement.identifier

instantiatesCanonical

0..*

canonical(ActivityDefinition | PlanDefinition)

There are no (further) constraints on this element

Element id

ServiceRequest.instantiatesCanonical

Short description

Instantiates FHIR protocol or definition

Definition

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.

Comments

Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

Data type

canonical(ActivityDefinition | PlanDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.instantiatesCanonical
v2: Varies by domain
rim: .outboundRelationship[typeCode=DEFN].target

instantiatesUri

0..*

There are no (further) constraints on this element

Element id

ServiceRequest.instantiatesUri

Short description

Instantiates external protocol or definition

Definition

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.

Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

Data type

Reference(ServiceRequest)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.instantiatesUri
v2: Varies by domain
rim: .outboundRelationship[typeCode=DEFN].target

basedOn

Σ C

0..*

Reference(CarePlan | MedicationRequest | ServiceRequest)

There are no (further) constraints on this element

Element id

ServiceRequest.basedOn

Short description

What request fulfills

Alternate names

fulfills

Definition

Plan/proposal/order fulfilled by this request.

Comments

Data type

Reference(CarePlan | MedicationRequest | ServiceRequest)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.basedOn
v2: ORC.8 (plus others)
rim: .outboundRelationship[typeCode=FLFS].target

replaces

Σ C

0..*

There are no (further) constraints on this element

Element id

ServiceRequest.replaces

Short description

What request replaces

Alternate names

supersedes, prior, renewed order

Definition

The request takes the place of the referenced completed or terminated request(s).

Comments

Data type

Reference(ServiceRequest)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.replaces
v2: Handled by message location of ORC (ORC.1=RO or RU)
rim: .outboundRelationship[typeCode=RPLC].target

requisition

0..1

There are no (further) constraints on this element

Element id

ServiceRequest.requisition

Short description

Composite Request ID

Alternate names

grouperId, groupIdentifier

Definition

A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.

Requirements

Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes.

Comments

Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.groupIdentifier
v2: ORC.4
rim: .inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier

status

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

ServiceRequest.status

Short description

Definition

The status of the order.

Comments

The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource.

Data type

Binding

The status of a service order.

RequestStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.status
w5: FiveWs.status
v2: ORC.5,RF1-1
rim: .status
quick: Action.currentStatus

intent

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

ServiceRequest.intent

Short description

Definition

Whether the request is a proposal, plan, an original order or a reflex order.

Comments

This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

Data type