DK MedCom Carecommunication
4.0.0 - release
DK MedCom Carecommunication
4.0.0 - release
This page is part of the DK MedCom CareCommunication (v4.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
| Official URL: http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-provenance | Version: 4.0.0 | |||
| Active as of 2024-06-28 | Computable Name: MedComCareCommunicationProvenance | |||
Provenance information about the current and preceeding message.
This profile is used as the Provenance in a CareCommunication message. This profile inherits from MedComMessagingProvenance and must be used as Provenance instance in the CareCommuncation message. The Provenance resource tracks information about the activity what was created, while referencing the current message and previous messages if such exist. Further, does the profile include the identifier of the message segment (also referred to as payload).
The element Provenance.entity is sliced. One slice is called payload, and contains the identifier for the payloads added in the current CareCommunication. The second slice is called previousMessage is used when the message is a reply or forwarding. In these cases, the Provenance.entity must refer to the previous message.
Please refer to the tab “Snapshot Table” below for the definition of the required content of a MedComCareCommunicationMessageHeader.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedComMessagingProvenance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Provenance |
0..* | MedComMessagingProvenance | Who, What, When for a set of resources | |
  target |
1..1 | Reference(MedComCareCommunicationMessageHeader) | Targets the MedComMessagingMessageHeader from the current message. | |
 activity |
1..1 | CodeableConcept | Activity that occurred Binding: MedComCareCommunicationMessageActivityCodes (required) | |
  Slices for entity |
1..* | BackboneElement | An entity used in this activity Slice: Unordered, Closed by value:role | |
   entity:preceedingMessage |
S | 0..1 | BackboneElement | Shall be included when the current message is a response to a previous FHIR message. |
  role |
1..1 | code | When a message is a response or a forwarding message the role shall be 'revision'. Required Pattern: revision | |
 what |
1..1 | Reference(Resource) | A reference to the previous message. If the previous message is a FHIR message , the reference element must be used and if the previous message is an EDIFACT or OIOXML, the identifier element must be used. | |
| reference |
0..1 | string | If the previous message is a FHIR message, this element must contain the MessageHeader.id from previous message. | |
 identifier |
0..1 | Identifier | If the previous message is EDIFACT or OIOXML, this element must be expressed as [lokationsnummer]#[brevid] from the EDIFACT or OIOXML message. | |
 entity:payload |
S | 1..* | BackboneElement | An identifier for the payload included during this revision. If more payloads are added, each payload must be represented with an individual entity. |
| role |
1..1 | code | The role shall be 'source' or 'revision'. Required Pattern: source | |
| what |
1..1 | Reference(Resource) | A reference to the payload included in this message. | |
| identifier |
1..1 | Identifier | The identifier of the newly included Communication.payload.extension.valueIdentifier must be included here. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Provenance.activity | required | MedComCareCommunicationMessageActivitieshttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-careCommunication-messagingActivities |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance |
0..* | MedComMessagingProvenance | Who, What, When for a set of resources | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 text |
S | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| target |
SΣ | 1..1 | Reference(MedComCareCommunicationMessageHeader) | Targets the MedComMessagingMessageHeader from the current message. |
 Slices for occurred[x] |
1..1 | dateTime | When the activity occurred Slice: Unordered, Closed by type:$this | |
  occurred[x]:occurredDateTime |
S | 1..1 | dateTime | A human readable date and time for when the message is sent. Shall include a date, a time and timezone. |
| recorded |
SΣ | 1..1 | instant | A system readable date and time for when the message is sent. |
| activity |
S | 1..1 | CodeableConcept | Activity that occurred Binding: MedComCareCommunicationMessageActivityCodes (required) |
| coding |
SΣ | 1..* | Coding | Code defined by a terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| agent |
S | 1..* | BackboneElement | The actors involved in the activity taking place |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| who |
SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | A reference to the actor of the activity, which shall be a MedComMessagingOrganization. If more actors has been involved, the element must be sliced. |
| Slices for entity |
S | 1..* | BackboneElement | An entity used in this activity Slice: Unordered, Closed by value:role |
| entity:All Slices |
Content/Rules for all slices | |||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
SΣ | 1..1 | code | When a message is a response, a correction or a forwarding message the role shall be 'revision' and when the message is a cancellation the role shall be 'removal'. Binding: ProvenanceEntityRole (required): How an entity was used in an activity. |
| what |
SΣ | 1..1 | Reference(Resource) | A reference to the previous message. If the previous message is a FHIR message, the reference element must be used and if the previous message is an EDIFACT or OIOXML, the identifier element must be used. |
| reference |
SΣC | 0..1 | string | If the previous message is a FHIR message, this element must hold the MessageHeader.id from previous message. |
| identifier |
SΣ | 0..1 | Identifier | If previous message is EDIFACT or OIOXML, this element must be expressed as [lokationsnummer]#[brevid] from the EDIFACT or OIOXML message. |
| entity:preceedingMessage |
S | 0..1 | BackboneElement | Shall be included when the current message is a response to a previous FHIR message. |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
SΣ | 1..1 | code | When a message is a response or a forwarding message the role shall be 'revision'. Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Required Pattern: revision |
| what |
SΣ | 1..1 | Reference(Resource) | A reference to the previous message. If the previous message is a FHIR message , the reference element must be used and if the previous message is an EDIFACT or OIOXML, the identifier element must be used. |
| reference |
SΣC | 0..1 | string | If the previous message is a FHIR message, this element must contain the MessageHeader.id from previous message. |
| identifier |
SΣ | 0..1 | Identifier | If the previous message is EDIFACT or OIOXML, this element must be expressed as [lokationsnummer]#[brevid] from the EDIFACT or OIOXML message. |
| entity:payload |
S | 1..* | BackboneElement | An identifier for the payload included during this revision. If more payloads are added, each payload must be represented with an individual entity. |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
SΣ | 1..1 | code | The role shall be 'source' or 'revision'. Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Required Pattern: source |
| what |
SΣ | 1..1 | Reference(Resource) | A reference to the payload included in this message. |
| reference |
SΣC | 0..1 | string | If the previous message is a FHIR message, this element must hold the MessageHeader.id from previous message. |
| identifier |
SΣ | 1..1 | Identifier | The identifier of the newly included Communication.payload.extension.valueIdentifier must be included here. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Provenance.activity | required | MedComCareCommunicationMessageActivitieshttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-careCommunication-messagingActivities | |
| Provenance.entity.role | required | ProvenanceEntityRolehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard | |
| Provenance.entity:preceedingMessage.role | required | Pattern: revisionhttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard | |
| Provenance.entity:payload.role | required | Pattern: sourcehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | 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-4 | error | Provenance | 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-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | MedComMessagingProvenance | Who, What, When for a set of resources | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
S | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| target |
SΣ | 1..1 | Reference(MedComCareCommunicationMessageHeader) | Targets the MedComMessagingMessageHeader from the current message. | ||||
| Slices for occurred[x] |
1..1 | dateTime | When the activity occurred Slice: Unordered, Closed by type:$this | |||||
| occurred[x]:occurredDateTime |
S | 1..1 | dateTime | A human readable date and time for when the message is sent. Shall include a date, a time and timezone. | ||||
| recorded |
SΣ | 1..1 | instant | A system readable date and time for when the message is sent. | ||||
| policy |
0..* | uri | Policy or plan the activity was defined by | |||||
| location |
0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
| reason |
0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
| activity |
S | 1..1 | CodeableConcept | Activity that occurred Binding: MedComCareCommunicationMessageActivityCodes (required) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| agent |
S | 1..* | BackboneElement | The actors involved in the activity taking place | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | ||||
| role |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| who |
SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | A reference to the actor of the activity, which shall be a MedComMessagingOrganization. If more actors has been involved, the element must be sliced. | ||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| Slices for entity |
S | 1..* | BackboneElement | An entity used in this activity Slice: Unordered, Closed by value:role | ||||
| entity:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
SΣ | 1..1 | code | When a message is a response, a correction or a forwarding message the role shall be 'revision' and when the message is a cancellation the role shall be 'removal'. Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||
| what |
SΣ | 1..1 | Reference(Resource) | A reference to the previous message. If the previous message is a FHIR message, the reference element must be used and if the previous message is an EDIFACT or OIOXML, the identifier element must be used. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
SΣC | 0..1 | string | If the previous message is a FHIR message, this element must hold the MessageHeader.id from previous message. | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
SΣ | 0..1 | Identifier | If previous message is EDIFACT or OIOXML, this element must be expressed as [lokationsnummer]#[brevid] from the EDIFACT or OIOXML message. | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| entity:preceedingMessage |
S | 0..1 | BackboneElement | Shall be included when the current message is a response to a previous FHIR message. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
SΣ | 1..1 | code | When a message is a response or a forwarding message the role shall be 'revision'. Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Required Pattern: revision | ||||
 what |
SΣ | 1..1 | Reference(Resource) | A reference to the previous message. If the previous message is a FHIR message , the reference element must be used and if the previous message is an EDIFACT or OIOXML, the identifier element must be used. | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
SΣC | 0..1 | string | If the previous message is a FHIR message, this element must contain the MessageHeader.id from previous message. | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
SΣ | 0..1 | Identifier | If the previous message is EDIFACT or OIOXML, this element must be expressed as [lokationsnummer]#[brevid] from the EDIFACT or OIOXML message. | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
 agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| entity:payload |
S | 1..* | BackboneElement | An identifier for the payload included during this revision. If more payloads are added, each payload must be represented with an individual entity. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
SΣ | 1..1 | code | The role shall be 'source' or 'revision'. Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Required Pattern: source | ||||
| what |
SΣ | 1..1 | Reference(Resource) | A reference to the payload included in this message. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
SΣC | 0..1 | string | If the previous message is a FHIR message, this element must hold the MessageHeader.id from previous message. | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
SΣ | 1..1 | Identifier | The identifier of the newly included Communication.payload.extension.valueIdentifier must be included here. | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| signature |
0..* | Signature | Signature on target | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Provenance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Provenance.reason | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Provenance.activity | required | MedComCareCommunicationMessageActivitieshttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-careCommunication-messagingActivities | ||||
| Provenance.agent.type | extensible | ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-typefrom the FHIR Standard | ||||
| Provenance.agent.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| Provenance.entity.role | required | ProvenanceEntityRolehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard | ||||
| Provenance.entity.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Provenance.entity:preceedingMessage.role | required | Pattern: revisionhttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard | ||||
| Provenance.entity:preceedingMessage.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Provenance.entity:payload.role | required | Pattern: sourcehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard | ||||
| Provenance.entity:payload.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | 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-4 | error | Provenance | 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-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MedComMessagingProvenance
Summary
Mandatory: 3 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MedComMessagingProvenance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance |
0..* | MedComMessagingProvenance | Who, What, When for a set of resources | |
| target |
1..1 | Reference(MedComCareCommunicationMessageHeader) | Targets the MedComMessagingMessageHeader from the current message. | |
| activity |
1..1 | CodeableConcept | Activity that occurred Binding: MedComCareCommunicationMessageActivityCodes (required) | |
| Slices for entity |
1..* | BackboneElement | An entity used in this activity Slice: Unordered, Closed by value:role | |
| entity:preceedingMessage |
S | 0..1 | BackboneElement | Shall be included when the current message is a response to a previous FHIR message. |
| role |
1..1 | code | When a message is a response or a forwarding message the role shall be 'revision'. Required Pattern: revision | |
| what |
1..1 | Reference(Resource) | A reference to the previous message. If the previous message is a FHIR message , the reference element must be used and if the previous message is an EDIFACT or OIOXML, the identifier element must be used. | |
| reference |
0..1 | string | If the previous message is a FHIR message, this element must contain the MessageHeader.id from previous message. | |
| identifier |
0..1 | Identifier | If the previous message is EDIFACT or OIOXML, this element must be expressed as [lokationsnummer]#[brevid] from the EDIFACT or OIOXML message. | |
| entity:payload |
S | 1..* | BackboneElement | An identifier for the payload included during this revision. If more payloads are added, each payload must be represented with an individual entity. |
| role |
1..1 | code | The role shall be 'source' or 'revision'. Required Pattern: source | |
| what |
1..1 | Reference(Resource) | A reference to the payload included in this message. | |
| identifier |
1..1 | Identifier | The identifier of the newly included Communication.payload.extension.valueIdentifier must be included here. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Provenance.activity | required | MedComCareCommunicationMessageActivitieshttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-careCommunication-messagingActivities |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Provenance |
0..* | MedComMessagingProvenance | Who, What, When for a set of resources | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text |
S | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| target |
SΣ | 1..1 | Reference(MedComCareCommunicationMessageHeader) | Targets the MedComMessagingMessageHeader from the current message. |
| Slices for occurred[x] |
1..1 | dateTime | When the activity occurred Slice: Unordered, Closed by type:$this | |
| occurred[x]:occurredDateTime |
S | 1..1 | dateTime | A human readable date and time for when the message is sent. Shall include a date, a time and timezone. |
| recorded |
SΣ | 1..1 | instant | A system readable date and time for when the message is sent. |
| activity |
S | 1..1 | CodeableConcept | Activity that occurred Binding: MedComCareCommunicationMessageActivityCodes (required) |
| coding |
SΣ | 1..* | Coding | Code defined by a terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| agent |
S | 1..* | BackboneElement | The actors involved in the activity taking place |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| who |
SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | A reference to the actor of the activity, which shall be a MedComMessagingOrganization. If more actors has been involved, the element must be sliced. |
| Slices for entity |
S | 1..* | BackboneElement | An entity used in this activity Slice: Unordered, Closed by value:role |
| entity:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
SΣ | 1..1 | code | When a message is a response, a correction or a forwarding message the role shall be 'revision' and when the message is a cancellation the role shall be 'removal'. Binding: ProvenanceEntityRole (required): How an entity was used in an activity. |
| what |
SΣ | 1..1 | Reference(Resource) | A reference to the previous message. If the previous message is a FHIR message, the reference element must be used and if the previous message is an EDIFACT or OIOXML, the identifier element must be used. |
| reference |
SΣC | 0..1 | string | If the previous message is a FHIR message, this element must hold the MessageHeader.id from previous message. |
| identifier |
SΣ | 0..1 | Identifier | If previous message is EDIFACT or OIOXML, this element must be expressed as [lokationsnummer]#[brevid] from the EDIFACT or OIOXML message. |
| entity:preceedingMessage |
S | 0..1 | BackboneElement | Shall be included when the current message is a response to a previous FHIR message. |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
SΣ | 1..1 | code | When a message is a response or a forwarding message the role shall be 'revision'. Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Required Pattern: revision |
| what |
SΣ | 1..1 | Reference(Resource) | A reference to the previous message. If the previous message is a FHIR message , the reference element must be used and if the previous message is an EDIFACT or OIOXML, the identifier element must be used. |
| reference |
SΣC | 0..1 | string | If the previous message is a FHIR message, this element must contain the MessageHeader.id from previous message. |
| identifier |
SΣ | 0..1 | Identifier | If the previous message is EDIFACT or OIOXML, this element must be expressed as [lokationsnummer]#[brevid] from the EDIFACT or OIOXML message. |
| entity:payload |
S | 1..* | BackboneElement | An identifier for the payload included during this revision. If more payloads are added, each payload must be represented with an individual entity. |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role |
SΣ | 1..1 | code | The role shall be 'source' or 'revision'. Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Required Pattern: source |
| what |
SΣ | 1..1 | Reference(Resource) | A reference to the payload included in this message. |
| reference |
SΣC | 0..1 | string | If the previous message is a FHIR message, this element must hold the MessageHeader.id from previous message. |
| identifier |
SΣ | 1..1 | Identifier | The identifier of the newly included Communication.payload.extension.valueIdentifier must be included here. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Provenance.activity | required | MedComCareCommunicationMessageActivitieshttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-careCommunication-messagingActivities | |
| Provenance.entity.role | required | ProvenanceEntityRolehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard | |
| Provenance.entity:preceedingMessage.role | required | Pattern: revisionhttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard | |
| Provenance.entity:payload.role | required | Pattern: sourcehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | 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-4 | error | Provenance | 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-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Provenance |
0..* | MedComMessagingProvenance | Who, What, When for a set of resources | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
S | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| target |
SΣ | 1..1 | Reference(MedComCareCommunicationMessageHeader) | Targets the MedComMessagingMessageHeader from the current message. | ||||
| Slices for occurred[x] |
1..1 | dateTime | When the activity occurred Slice: Unordered, Closed by type:$this | |||||
| occurred[x]:occurredDateTime |
S | 1..1 | dateTime | A human readable date and time for when the message is sent. Shall include a date, a time and timezone. | ||||
| recorded |
SΣ | 1..1 | instant | A system readable date and time for when the message is sent. | ||||
| policy |
0..* | uri | Policy or plan the activity was defined by | |||||
| location |
0..1 | Reference(Location) | Where the activity occurred, if relevant | |||||
| reason |
0..* | CodeableConcept | Reason the activity is occurring Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
| activity |
S | 1..1 | CodeableConcept | Activity that occurred Binding: MedComCareCommunicationMessageActivityCodes (required) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| agent |
S | 1..* | BackboneElement | The actors involved in the activity taking place | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..1 | CodeableConcept | How the agent participated Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity. | ||||
| role |
0..* | CodeableConcept | What the agents role was Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity. | |||||
| who |
SΣ | 1..1 | Reference(MedComMessagingOrganization) {b} | A reference to the actor of the activity, which shall be a MedComMessagingOrganization. If more actors has been involved, the element must be sliced. | ||||
| onBehalfOf |
0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) | Who the agent is representing | |||||
| Slices for entity |
S | 1..* | BackboneElement | An entity used in this activity Slice: Unordered, Closed by value:role | ||||
| entity:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
SΣ | 1..1 | code | When a message is a response, a correction or a forwarding message the role shall be 'revision' and when the message is a cancellation the role shall be 'removal'. Binding: ProvenanceEntityRole (required): How an entity was used in an activity. | ||||
| what |
SΣ | 1..1 | Reference(Resource) | A reference to the previous message. If the previous message is a FHIR message, the reference element must be used and if the previous message is an EDIFACT or OIOXML, the identifier element must be used. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
SΣC | 0..1 | string | If the previous message is a FHIR message, this element must hold the MessageHeader.id from previous message. | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
SΣ | 0..1 | Identifier | If previous message is EDIFACT or OIOXML, this element must be expressed as [lokationsnummer]#[brevid] from the EDIFACT or OIOXML message. | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| entity:preceedingMessage |
S | 0..1 | BackboneElement | Shall be included when the current message is a response to a previous FHIR message. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
SΣ | 1..1 | code | When a message is a response or a forwarding message the role shall be 'revision'. Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Required Pattern: revision | ||||
| what |
SΣ | 1..1 | Reference(Resource) | A reference to the previous message. If the previous message is a FHIR message , the reference element must be used and if the previous message is an EDIFACT or OIOXML, the identifier element must be used. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
SΣC | 0..1 | string | If the previous message is a FHIR message, this element must contain the MessageHeader.id from previous message. | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
SΣ | 0..1 | Identifier | If the previous message is EDIFACT or OIOXML, this element must be expressed as [lokationsnummer]#[brevid] from the EDIFACT or OIOXML message. | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| entity:payload |
S | 1..* | BackboneElement | An identifier for the payload included during this revision. If more payloads are added, each payload must be represented with an individual entity. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| role |
SΣ | 1..1 | code | The role shall be 'source' or 'revision'. Binding: ProvenanceEntityRole (required): How an entity was used in an activity. Required Pattern: source | ||||
| what |
SΣ | 1..1 | Reference(Resource) | A reference to the payload included in this message. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
SΣC | 0..1 | string | If the previous message is a FHIR message, this element must hold the MessageHeader.id from previous message. | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
SΣ | 1..1 | Identifier | The identifier of the newly included Communication.payload.extension.valueIdentifier must be included here. | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| agent |
0..* | See agent (Provenance) | Entity is attributed to this agent | |||||
| signature |
0..* | Signature | Signature on target | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Provenance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Provenance.reason | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
| Provenance.activity | required | MedComCareCommunicationMessageActivitieshttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-careCommunication-messagingActivities | ||||
| Provenance.agent.type | extensible | ProvenanceParticipantTypehttp://hl7.org/fhir/ValueSet/provenance-agent-typefrom the FHIR Standard | ||||
| Provenance.agent.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-typefrom the FHIR Standard | ||||
| Provenance.entity.role | required | ProvenanceEntityRolehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard | ||||
| Provenance.entity.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Provenance.entity:preceedingMessage.role | required | Pattern: revisionhttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard | ||||
| Provenance.entity:preceedingMessage.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Provenance.entity:payload.role | required | Pattern: sourcehttp://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1from the FHIR Standard | ||||
| Provenance.entity:payload.what.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Provenance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Provenance | 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-4 | error | Provenance | 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-5 | error | Provenance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Provenance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MedComMessagingProvenance
Summary
Mandatory: 3 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ MedCom. Package medcom.fhir.dk.carecommunication#4.0.0 based on FHIR 4.0.1. Generated 2024-06-28
Links: Table of Contents |
QA Report
| Accessibility statement (Tilgængelighedserklæring)