Profile-CDR-MessageHeader
Overview
Defines the CDR MessageHeader profile, derived from the Data Standards Wales MessageHeader profile, for use in CDR FHIR messages. This profile constrains the message source endpoint to an NHS Wales Application Instance Identifier (AII) OID URN and requires the message event code to be drawn from the CDR Message Events value set.
Formal Views of Profile Content
- Overview
- Detailed View
| CDRMessageHeader (MessageHeader) | C | DataStandardsWalesMessageHeader | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| event[x] | Σ | 1..1 | CodingBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | Σ | 0..1 | uri |
| version | Σ | 0..1 | string |
| code | Σ | 0..1 | codeBinding |
| display | Σ | 0..1 | string |
| userSelected | Σ | 0..1 | boolean |
| destination | Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| name | Σ | 0..1 | string |
| target | Σ C | 0..1 | Reference(DataStandardsWalesDevice) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(DataStandardsWalesOrganization) |
| display | Σ | 0..1 | string |
| endpoint | Σ | 1..1 | url |
| receiver | Σ C | 0..1 | Reference(DataStandardsWalesOrganization | DataStandardsWalesPractitioner | DataStandardsWalesPractitionerRole) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(DataStandardsWalesOrganization) |
| display | Σ | 0..1 | string |
| sender | Σ C | 0..1 | Reference(DataStandardsWalesOrganization | DataStandardsWalesPractitioner | DataStandardsWalesPractitionerRole) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(DataStandardsWalesOrganization) |
| display | Σ | 0..1 | string |
| enterer | Σ C | 0..1 | Reference(DataStandardsWalesPractitioner | DataStandardsWalesPractitionerRole) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(DataStandardsWalesOrganization) |
| display | Σ | 0..1 | string |
| author | Σ C | 0..1 | Reference(DataStandardsWalesPractitioner | DataStandardsWalesPractitionerRole) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(DataStandardsWalesOrganization) |
| display | Σ | 0..1 | string |
| source | Σ | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| name | Σ | 0..1 | string |
| software | Σ | 0..1 | string |
| version | Σ | 0..1 | string |
| contact | Σ C | 0..1 | ContactPoint |
| endpoint | Σ C | 1..1 | url |
| responsible | Σ C | 0..1 | Reference(DataStandardsWalesOrganization | DataStandardsWalesPractitioner | DataStandardsWalesPractitionerRole) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(DataStandardsWalesOrganization) |
| display | Σ | 0..1 | string |
| reason | Σ | 0..1 | CodeableConcept |
| response | Σ | 0..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| identifier | Σ | 1..1 | id |
| code | Σ | 1..1 | codeBinding |
| details | Σ C | 0..1 | Reference(OperationOutcome) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(DataStandardsWalesOrganization) |
| display | Σ | 0..1 | string |
| focus | Σ C | 0..* | Reference(Resource) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | Σ | 0..1 | uri |
| value | Σ | 0..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(DataStandardsWalesOrganization) |
| display | Σ | 0..1 | string |
| definition | Σ | 0..1 | canonical(MessageDefinition) |
| MessageHeader | C | |||
| Short | A resource that describes a message that is exchanged between systems | |||
| Definition | The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. | |||
| Cardinality | 0..* | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.id | Σ | |||
| Short | Logical id of this artifact | |||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |||
| Cardinality | 0..1 | |||
| Type | id | |||
| Summary | True | |||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.meta | Σ | |||
| Short | Metadata about the resource | |||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |||
| Cardinality | 0..1 | |||
| Type | Meta | |||
| Summary | True | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.implicitRules | Σ ?! | |||
| Short | A set of rules under which this content was created | |||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Modifier | True | |||
| Summary | True | |||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.language | ||||
| Short | Language of the resource content | |||
| Definition | The base language in which the resource is written. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | A human language. Binding extensions
| |||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.text | ||||
| Short | Text summary of the resource, for human interpretation | |||
| 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. | |||
| Cardinality | 0..1 | |||
| Type | Narrative | |||
| Alias | narrative, html, xhtml, display | |||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.contained | ||||
| Short | Contained, inline Resources | |||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |||
| Cardinality | 0..* | |||
| Type | Resource | |||
| Alias | inline resources, anonymous resources, contained resources | |||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | |||
| Mappings |
| |||
| MessageHeader.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.modifierExtension | ?! C | |||
| Short | Extensions that cannot be ignored | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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). | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Modifier | True | |||
| Alias | extensions, user content | |||
| 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 | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.event[x] | Σ | |||
| Short | Code for the event this message represents or link to event definition | |||
| Definition | Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition. | |||
| Cardinality | 1..1 | |||
| Type | Coding | |||
| Binding | NHS Wales Message Events | |||
| Summary | True | |||
| Requirements | Drives the behavior associated with this message. | |||
| Comments | The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.event[x].id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.event[x].extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.event[x].system | Σ | |||
| Short | Identity of the terminology system | |||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Summary | True | |||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | |||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.event[x].version | Σ | |||
| Short | Version of the system - if relevant | |||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.event[x].code | Σ | |||
| Short | Symbol in syntax defined by the system | |||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | A value set containing all event codes for FHIR messages events handled by the CDR. | |||
| Summary | True | |||
| Requirements | Need to refer to a particular code in the system. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.event[x].display | Σ | |||
| Short | Representation defined by the system | |||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.event[x].userSelected | Σ | |||
| Short | If this coding was chosen directly by the user | |||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | |||
| Cardinality | 0..1 | |||
| Type | boolean | |||
| Summary | True | |||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | |||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination | Σ | |||
| Short | Message destination application(s) | |||
| Definition | The destination application which the message is intended for. | |||
| Cardinality | 0..* | |||
| Type | BackboneElement | |||
| Summary | True | |||
| Requirements | Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient". | |||
| Comments | There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.destination.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.modifierExtension | Σ ?! C | |||
| Short | Extensions that cannot be ignored even if unrecognized | |||
| 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). | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Modifier | True | |||
| Summary | True | |||
| Alias | extensions, user content, modifiers | |||
| 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 | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.name | Σ | |||
| Short | Name of system | |||
| Definition | Human-readable name for the target system. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Requirements | May be used for routing of response and/or to support audit. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.target | Σ C | |||
| Short | Particular delivery destination within the destination | |||
| Definition | Identifies the target end system in situations where the initial message transmission is to an intermediary system. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesDevice) | |||
| Summary | True | |||
| Requirements | Supports multi-hop routing. | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.target.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.destination.target.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.target.reference | Σ C | |||
| Short | Literal reference, Relative, internal or absolute URL | |||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.target.type | Σ | |||
| Short | Type the reference refers to (e.g. "Patient") | |||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | |||
| Summary | True | |||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.target.identifier | Σ | |||
| Short | Logical reference, when literal reference is not known | |||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |||
| Cardinality | 0..1 | |||
| Type | Identifier | |||
| Summary | True | |||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.target.identifier.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.destination.target.identifier.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.target.identifier.use | Σ ?! | |||
| Short | usual | official | temp | secondary | old (If known) | |||
| Definition | The purpose of this identifier. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | Identifies the purpose for this identifier, if known . | |||
| Modifier | True | |||
| Summary | True | |||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.target.identifier.type | Σ | |||
| Short | Description of identifier | |||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Summary | True | |||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.target.identifier.system | Σ | |||
| Short | The namespace for the identifier value | |||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Summary | True | |||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |||
| Comments | Identifier.system is always case sensitive. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | Generalhttp://www.acme.com/identifiers/patient | |||
| Mappings |
| |||
| MessageHeader.destination.target.identifier.value | Σ | |||
| Short | The value that is unique | |||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | General123456 | |||
| Mappings |
| |||
| MessageHeader.destination.target.identifier.period | Σ C | |||
| Short | Time period when id is/was valid for use | |||
| Definition | Time period during which identifier is/was valid for use. | |||
| Cardinality | 0..1 | |||
| Type | Period | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.target.identifier.assigner | Σ C | |||
| Short | Organization that issued id (may be just text) | |||
| Definition | Organization that issued/manages the identifier. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesOrganization) | |||
| Summary | True | |||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.target.display | Σ | |||
| Short | Text alternative for the resource | |||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.endpoint | Σ | |||
| Short | Actual destination address or id | |||
| Definition | Indicates where the message should be routed to. | |||
| Cardinality | 1..1 | |||
| Type | url | |||
| Summary | True | |||
| Requirements | Identifies where to route the message. | |||
| Comments | The id may be a non-resolvable URI for systems that do not use standard network-based addresses. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.receiver | Σ C | |||
| Short | Intended "real-world" recipient for the data | |||
| Definition | Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesOrganization | DataStandardsWalesPractitioner | DataStandardsWalesPractitionerRole) | |||
| Summary | True | |||
| Requirements | Allows routing beyond just the application level. | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.receiver.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.destination.receiver.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.receiver.reference | Σ C | |||
| Short | Literal reference, Relative, internal or absolute URL | |||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.receiver.type | Σ | |||
| Short | Type the reference refers to (e.g. "Patient") | |||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | |||
| Summary | True | |||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.receiver.identifier | Σ | |||
| Short | Logical reference, when literal reference is not known | |||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |||
| Cardinality | 0..1 | |||
| Type | Identifier | |||
| Summary | True | |||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.receiver.identifier.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.destination.receiver.identifier.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.receiver.identifier.use | Σ ?! | |||
| Short | usual | official | temp | secondary | old (If known) | |||
| Definition | The purpose of this identifier. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | Identifies the purpose for this identifier, if known . | |||
| Modifier | True | |||
| Summary | True | |||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.receiver.identifier.type | Σ | |||
| Short | Description of identifier | |||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Summary | True | |||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.receiver.identifier.system | Σ | |||
| Short | The namespace for the identifier value | |||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Summary | True | |||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |||
| Comments | Identifier.system is always case sensitive. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | Generalhttp://www.acme.com/identifiers/patient | |||
| Mappings |
| |||
| MessageHeader.destination.receiver.identifier.value | Σ | |||
| Short | The value that is unique | |||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | General123456 | |||
| Mappings |
| |||
| MessageHeader.destination.receiver.identifier.period | Σ C | |||
| Short | Time period when id is/was valid for use | |||
| Definition | Time period during which identifier is/was valid for use. | |||
| Cardinality | 0..1 | |||
| Type | Period | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.receiver.identifier.assigner | Σ C | |||
| Short | Organization that issued id (may be just text) | |||
| Definition | Organization that issued/manages the identifier. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesOrganization) | |||
| Summary | True | |||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.destination.receiver.display | Σ | |||
| Short | Text alternative for the resource | |||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.sender | Σ C | |||
| Short | Real world sender of the message | |||
| Definition | Identifies the sending system to allow the use of a trust relationship. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesOrganization | DataStandardsWalesPractitioner | DataStandardsWalesPractitionerRole) | |||
| Summary | True | |||
| Requirements | Allows routing beyond just the application level. | |||
| Comments | Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.sender.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.sender.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.sender.reference | Σ C | |||
| Short | Literal reference, Relative, internal or absolute URL | |||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.sender.type | Σ | |||
| Short | Type the reference refers to (e.g. "Patient") | |||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | |||
| Summary | True | |||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.sender.identifier | Σ | |||
| Short | Logical reference, when literal reference is not known | |||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |||
| Cardinality | 0..1 | |||
| Type | Identifier | |||
| Summary | True | |||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.sender.identifier.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.sender.identifier.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.sender.identifier.use | Σ ?! | |||
| Short | usual | official | temp | secondary | old (If known) | |||
| Definition | The purpose of this identifier. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | Identifies the purpose for this identifier, if known . | |||
| Modifier | True | |||
| Summary | True | |||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.sender.identifier.type | Σ | |||
| Short | Description of identifier | |||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Summary | True | |||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.sender.identifier.system | Σ | |||
| Short | The namespace for the identifier value | |||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Summary | True | |||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |||
| Comments | Identifier.system is always case sensitive. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | Generalhttp://www.acme.com/identifiers/patient | |||
| Mappings |
| |||
| MessageHeader.sender.identifier.value | Σ | |||
| Short | The value that is unique | |||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | General123456 | |||
| Mappings |
| |||
| MessageHeader.sender.identifier.period | Σ C | |||
| Short | Time period when id is/was valid for use | |||
| Definition | Time period during which identifier is/was valid for use. | |||
| Cardinality | 0..1 | |||
| Type | Period | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.sender.identifier.assigner | Σ C | |||
| Short | Organization that issued id (may be just text) | |||
| Definition | Organization that issued/manages the identifier. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesOrganization) | |||
| Summary | True | |||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.sender.display | Σ | |||
| Short | Text alternative for the resource | |||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.enterer | Σ C | |||
| Short | The source of the data entry | |||
| Definition | The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesPractitioner | DataStandardsWalesPractitionerRole) | |||
| Summary | True | |||
| Requirements | Need to know for audit/traceback requirements and possibly for authorization. | |||
| Comments | Usually only for the request but can be used in a response. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.enterer.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.enterer.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.enterer.reference | Σ C | |||
| Short | Literal reference, Relative, internal or absolute URL | |||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.enterer.type | Σ | |||
| Short | Type the reference refers to (e.g. "Patient") | |||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | |||
| Summary | True | |||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.enterer.identifier | Σ | |||
| Short | Logical reference, when literal reference is not known | |||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |||
| Cardinality | 0..1 | |||
| Type | Identifier | |||
| Summary | True | |||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.enterer.identifier.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.enterer.identifier.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.enterer.identifier.use | Σ ?! | |||
| Short | usual | official | temp | secondary | old (If known) | |||
| Definition | The purpose of this identifier. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | Identifies the purpose for this identifier, if known . | |||
| Modifier | True | |||
| Summary | True | |||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.enterer.identifier.type | Σ | |||
| Short | Description of identifier | |||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Summary | True | |||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.enterer.identifier.system | Σ | |||
| Short | The namespace for the identifier value | |||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Summary | True | |||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |||
| Comments | Identifier.system is always case sensitive. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | Generalhttp://www.acme.com/identifiers/patient | |||
| Mappings |
| |||
| MessageHeader.enterer.identifier.value | Σ | |||
| Short | The value that is unique | |||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | General123456 | |||
| Mappings |
| |||
| MessageHeader.enterer.identifier.period | Σ C | |||
| Short | Time period when id is/was valid for use | |||
| Definition | Time period during which identifier is/was valid for use. | |||
| Cardinality | 0..1 | |||
| Type | Period | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.enterer.identifier.assigner | Σ C | |||
| Short | Organization that issued id (may be just text) | |||
| Definition | Organization that issued/manages the identifier. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesOrganization) | |||
| Summary | True | |||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.enterer.display | Σ | |||
| Short | Text alternative for the resource | |||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.author | Σ C | |||
| Short | The source of the decision | |||
| Definition | The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesPractitioner | DataStandardsWalesPractitionerRole) | |||
| Summary | True | |||
| Requirements | Need to know for audit/traceback requirements and possibly for authorization. | |||
| Comments | Usually only for the request but can be used in a response. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.author.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.author.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.author.reference | Σ C | |||
| Short | Literal reference, Relative, internal or absolute URL | |||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.author.type | Σ | |||
| Short | Type the reference refers to (e.g. "Patient") | |||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | |||
| Summary | True | |||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.author.identifier | Σ | |||
| Short | Logical reference, when literal reference is not known | |||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |||
| Cardinality | 0..1 | |||
| Type | Identifier | |||
| Summary | True | |||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.author.identifier.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.author.identifier.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.author.identifier.use | Σ ?! | |||
| Short | usual | official | temp | secondary | old (If known) | |||
| Definition | The purpose of this identifier. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | Identifies the purpose for this identifier, if known . | |||
| Modifier | True | |||
| Summary | True | |||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.author.identifier.type | Σ | |||
| Short | Description of identifier | |||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Summary | True | |||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.author.identifier.system | Σ | |||
| Short | The namespace for the identifier value | |||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Summary | True | |||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |||
| Comments | Identifier.system is always case sensitive. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | Generalhttp://www.acme.com/identifiers/patient | |||
| Mappings |
| |||
| MessageHeader.author.identifier.value | Σ | |||
| Short | The value that is unique | |||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | General123456 | |||
| Mappings |
| |||
| MessageHeader.author.identifier.period | Σ C | |||
| Short | Time period when id is/was valid for use | |||
| Definition | Time period during which identifier is/was valid for use. | |||
| Cardinality | 0..1 | |||
| Type | Period | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.author.identifier.assigner | Σ C | |||
| Short | Organization that issued id (may be just text) | |||
| Definition | Organization that issued/manages the identifier. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesOrganization) | |||
| Summary | True | |||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.author.display | Σ | |||
| Short | Text alternative for the resource | |||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.source | Σ | |||
| Short | Message source application | |||
| Definition | The source application from which this message originated. | |||
| Cardinality | 1..1 | |||
| Type | BackboneElement | |||
| Summary | True | |||
| Requirements | Allows replies, supports audit. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.source.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.source.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.source.modifierExtension | Σ ?! C | |||
| Short | Extensions that cannot be ignored even if unrecognized | |||
| 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). | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Modifier | True | |||
| Summary | True | |||
| Alias | extensions, user content, modifiers | |||
| 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 | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.source.name | Σ | |||
| Short | Name of system | |||
| Definition | Human-readable name for the source system. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Requirements | May be used to support audit. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.source.software | Σ | |||
| Short | Name of software running the system | |||
| Definition | May include configuration or other information useful in debugging. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Requirements | Supports audit and possibly interface engine behavior. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.source.version | Σ | |||
| Short | Version of software running | |||
| Definition | Can convey versions of multiple systems in situations where a message passes through multiple hands. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Requirements | Supports audit and possibly interface engine behavior. | |||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.source.contact | Σ C | |||
| Short | Human contact for problems | |||
| Definition | An e-mail, phone, website or other contact point to use to resolve issues with message communications. | |||
| Cardinality | 0..1 | |||
| Type | ContactPoint | |||
| Summary | True | |||
| Requirements | Allows escalation of technical issues. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.source.endpoint | Σ C | |||
| Short | Actual message source address or id | |||
| Definition | Identifies the routing target to send acknowledgements to. | |||
| Cardinality | 1..1 | |||
| Type | url | |||
| Summary | True | |||
| Requirements | Identifies where to send responses, may influence security permissions. | |||
| Comments | The id may be a non-resolvable URI for systems that do not use standard network-based addresses. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.responsible | Σ C | |||
| Short | Final responsibility for event | |||
| Definition | The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesOrganization | DataStandardsWalesPractitioner | DataStandardsWalesPractitionerRole) | |||
| Summary | True | |||
| Requirements | Need to know for audit/traceback requirements and possibly for authorization. | |||
| Comments | Usually only for the request but can be used in a response. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.responsible.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.responsible.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.responsible.reference | Σ C | |||
| Short | Literal reference, Relative, internal or absolute URL | |||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.responsible.type | Σ | |||
| Short | Type the reference refers to (e.g. "Patient") | |||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | |||
| Summary | True | |||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.responsible.identifier | Σ | |||
| Short | Logical reference, when literal reference is not known | |||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |||
| Cardinality | 0..1 | |||
| Type | Identifier | |||
| Summary | True | |||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.responsible.identifier.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.responsible.identifier.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.responsible.identifier.use | Σ ?! | |||
| Short | usual | official | temp | secondary | old (If known) | |||
| Definition | The purpose of this identifier. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | Identifies the purpose for this identifier, if known . | |||
| Modifier | True | |||
| Summary | True | |||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.responsible.identifier.type | Σ | |||
| Short | Description of identifier | |||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Summary | True | |||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.responsible.identifier.system | Σ | |||
| Short | The namespace for the identifier value | |||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Summary | True | |||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |||
| Comments | Identifier.system is always case sensitive. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | Generalhttp://www.acme.com/identifiers/patient | |||
| Mappings |
| |||
| MessageHeader.responsible.identifier.value | Σ | |||
| Short | The value that is unique | |||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | General123456 | |||
| Mappings |
| |||
| MessageHeader.responsible.identifier.period | Σ C | |||
| Short | Time period when id is/was valid for use | |||
| Definition | Time period during which identifier is/was valid for use. | |||
| Cardinality | 0..1 | |||
| Type | Period | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.responsible.identifier.assigner | Σ C | |||
| Short | Organization that issued id (may be just text) | |||
| Definition | Organization that issued/manages the identifier. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesOrganization) | |||
| Summary | True | |||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.responsible.display | Σ | |||
| Short | Text alternative for the resource | |||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.reason | Σ | |||
| Short | Cause of event | |||
| Definition | Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | Reason for event occurrence. | |||
| Summary | True | |||
| Requirements | Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization. | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response | Σ | |||
| Short | If this is a reply to prior message | |||
| Definition | Information about the message that this message is a response to. Only present if this message is a response. | |||
| Cardinality | 0..1 | |||
| Type | BackboneElement | |||
| Summary | True | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.response.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.modifierExtension | Σ ?! C | |||
| Short | Extensions that cannot be ignored even if unrecognized | |||
| 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). | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Modifier | True | |||
| Summary | True | |||
| Alias | extensions, user content, modifiers | |||
| 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 | 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.identifier | Σ | |||
| Short | Id of original message | |||
| Definition | The MessageHeader.id of the message to which this message is a response. | |||
| Cardinality | 1..1 | |||
| Type | id | |||
| Summary | True | |||
| Requirements | Allows receiver to know what message is being responded to. | |||
| Comments | RFC 4122 | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.code | Σ | |||
| Short | ok | transient-error | fatal-error | |||
| Definition | Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. | |||
| Cardinality | 1..1 | |||
| Type | code | |||
| Binding | The kind of response to a message. | |||
| Summary | True | |||
| Requirements | Allows the sender of the acknowledge message to know if the request was successful or if action is needed. | |||
| Comments | This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.details | Σ C | |||
| Short | Specific list of hints/warnings/errors | |||
| Definition | Full details of any issues found in the message. | |||
| Cardinality | 0..1 | |||
| Type | Reference(OperationOutcome) | |||
| Summary | True | |||
| Requirements | Allows the sender of the message to determine what the specific issues are. | |||
| Comments | This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.details.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.response.details.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.details.reference | Σ C | |||
| Short | Literal reference, Relative, internal or absolute URL | |||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.details.type | Σ | |||
| Short | Type the reference refers to (e.g. "Patient") | |||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | |||
| Summary | True | |||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.details.identifier | Σ | |||
| Short | Logical reference, when literal reference is not known | |||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |||
| Cardinality | 0..1 | |||
| Type | Identifier | |||
| Summary | True | |||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.details.identifier.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.response.details.identifier.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.details.identifier.use | Σ ?! | |||
| Short | usual | official | temp | secondary | old (If known) | |||
| Definition | The purpose of this identifier. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | Identifies the purpose for this identifier, if known . | |||
| Modifier | True | |||
| Summary | True | |||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.details.identifier.type | Σ | |||
| Short | Description of identifier | |||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Summary | True | |||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.details.identifier.system | Σ | |||
| Short | The namespace for the identifier value | |||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Summary | True | |||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |||
| Comments | Identifier.system is always case sensitive. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | Generalhttp://www.acme.com/identifiers/patient | |||
| Mappings |
| |||
| MessageHeader.response.details.identifier.value | Σ | |||
| Short | The value that is unique | |||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | General123456 | |||
| Mappings |
| |||
| MessageHeader.response.details.identifier.period | Σ C | |||
| Short | Time period when id is/was valid for use | |||
| Definition | Time period during which identifier is/was valid for use. | |||
| Cardinality | 0..1 | |||
| Type | Period | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.details.identifier.assigner | Σ C | |||
| Short | Organization that issued id (may be just text) | |||
| Definition | Organization that issued/manages the identifier. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesOrganization) | |||
| Summary | True | |||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.response.details.display | Σ | |||
| Short | Text alternative for the resource | |||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.focus | Σ C | |||
| Short | The actual content of the message | |||
| Definition | The actual data of the message - a reference to the root/focus class of the event. | |||
| Cardinality | 0..* | |||
| Type | Reference(Resource) | |||
| Summary | True | |||
| Requirements | Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources. | |||
| Comments | The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.focus.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.focus.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.focus.reference | Σ C | |||
| Short | Literal reference, Relative, internal or absolute URL | |||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.focus.type | Σ | |||
| Short | Type the reference refers to (e.g. "Patient") | |||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | |||
| Summary | True | |||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.focus.identifier | Σ | |||
| Short | Logical reference, when literal reference is not known | |||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | |||
| Cardinality | 0..1 | |||
| Type | Identifier | |||
| Summary | True | |||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.focus.identifier.id | ||||
| Short | 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. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Mappings |
| |||
| MessageHeader.focus.identifier.extension | C | |||
| Short | Additional content defined by implementations | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | |||
| Cardinality | 0..* | |||
| Type | Extension | |||
| Alias | extensions, user content | |||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.focus.identifier.use | Σ ?! | |||
| Short | usual | official | temp | secondary | old (If known) | |||
| Definition | The purpose of this identifier. | |||
| Cardinality | 0..1 | |||
| Type | code | |||
| Binding | Identifies the purpose for this identifier, if known . | |||
| Modifier | True | |||
| Summary | True | |||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.focus.identifier.type | Σ | |||
| Short | Description of identifier | |||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Cardinality | 0..1 | |||
| Type | CodeableConcept | |||
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||
| Summary | True | |||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.focus.identifier.system | Σ | |||
| Short | The namespace for the identifier value | |||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||
| Cardinality | 0..1 | |||
| Type | uri | |||
| Summary | True | |||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |||
| Comments | Identifier.system is always case sensitive. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | Generalhttp://www.acme.com/identifiers/patient | |||
| Mappings |
| |||
| MessageHeader.focus.identifier.value | Σ | |||
| Short | The value that is unique | |||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Examples | General123456 | |||
| Mappings |
| |||
| MessageHeader.focus.identifier.period | Σ C | |||
| Short | Time period when id is/was valid for use | |||
| Definition | Time period during which identifier is/was valid for use. | |||
| Cardinality | 0..1 | |||
| Type | Period | |||
| Summary | True | |||
| 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. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.focus.identifier.assigner | Σ C | |||
| Short | Organization that issued id (may be just text) | |||
| Definition | Organization that issued/manages the identifier. | |||
| Cardinality | 0..1 | |||
| Type | Reference(DataStandardsWalesOrganization) | |||
| Summary | True | |||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.focus.display | Σ | |||
| Short | Text alternative for the resource | |||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | |||
| Cardinality | 0..1 | |||
| Type | string | |||
| Summary | True | |||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | |||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
| MessageHeader.definition | Σ | |||
| Short | Link to the definition for this message | |||
| Definition | Permanent link to the MessageDefinition for this message. | |||
| Cardinality | 0..1 | |||
| Type | canonical(MessageDefinition) | |||
| Summary | True | |||
| Requirements | Allows sender to define the expected contents of the message. | |||
| Comments | ||||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | |||
| Constraints |
| |||
| Mappings |
| |||
Example
Metadata
| Name | Canonical_URL | Status |
|---|---|---|
| CDRMessageHeader | https://fhir.nhs.wales/StructureDefinition/CDR-MessageHeader | draft |