DCH-MessageHeader-1
MessageHeader | |
Definition | |
Control | 0..* |
Type | MessageHeader |
Comments | |
MessageHeader.id | |
Definition |
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 ? |
Type | Id |
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. Bundles always have an id, though it is usually a generated UUID. |
MessageHeader.meta | |
Definition |
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 ? |
Type | Meta |
Comments | |
MessageHeader.implicitRules | |
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. |
Control | 0..1 ? |
Type | Uri |
Is Modifier | 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 as much as possible. |
MessageHeader.language | |
Definition |
The base language in which the resource is written. |
Control | 0..1 ? |
Binding |
A human language. The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | Code |
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). |
MessageHeader.text | |
Definition |
A human-readable narrative that contains a summary of the resource, and may 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. |
Control | 0..1 ? |
Type | Narrative |
Aliases | narrative, html, xhtml, display |
Comments |
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
MessageHeader.contained | |
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. |
Control | 0..* |
Type | Resource |
Aliases | 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. |
MessageHeader.extension(messageEventType) | |
Definition |
The type of event applicable to the Child Health event message. |
Control | 1..1 |
Type | Extension |
Comments | |
MessageHeader.modifierExtension | |
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. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | 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. |
MessageHeader.timestamp | |
Definition |
The time that the message was sent. |
Control | 1..1 ? |
Type | Instant |
Requirements |
Allows limited detection of out-of-order and delayed transmission. Also supports audit. |
Comments |
Note: This is intended for precisely observed times, typically system logs etc., and not human-reported times - for them, see date and dateTime below. Time zone is always required |
MessageHeader.event | |
Definition |
The type of Child Health Event. |
Control | 0..* |
Binding |
The type of Child Health Event The codes SHALL be taken from https://fhir.nhs.uk/ValueSet/DCH-ChildHealthEventType-1 |
Comments | |
MessageHeader.event.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MessageHeader.event.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* ? |
Type | Extension |
Aliases | 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. |
MessageHeader.event.system | |
Definition |
The type of event applicable to the Child Health Event message. |
Control | 1..* |
Comments | |
Fixed Value | https://fhir.nhs.uk/DCH-ChildHealthEventType-1 |
MessageHeader.event.code | |
Definition | |
Control | 1..* |
Comments | |
MessageHeader.event.display | |
Definition | |
Control | 1..* |
Comments | |
MessageHeader.source | |
Definition |
The source application from which this message originated. |
Control | 1..1 ? |
Type | BackboneElement |
Requirements |
Allows replies, supports audit. |
Comments | |
MessageHeader.source.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MessageHeader.source.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* ? |
Type | Extension |
Aliases | 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. |
MessageHeader.source.modifierExtension | |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
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. |
MessageHeader.source.name | |
Definition |
Human-readable name for the source system. |
Control | 0..1 ? |
Type | String |
Requirements |
May be used to support audit. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MessageHeader.source.software | |
Definition |
May include configuration or other information useful in debugging. |
Control | 0..1 ? |
Type | String |
Requirements |
Supports audit and possibly interface engine behavior. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MessageHeader.source.version | |
Definition |
Can convey versions of multiple systems in situations where a message passes through multiple hands. |
Control | 0..1 ? |
Type | String |
Requirements |
Supports audit and possibly interface engine behavior. |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MessageHeader.source.contact | |
Definition |
An e-mail, phone, website or other contact point to use to resolve issues with message communications. |
Control | 0..1 ? |
Type | ContactPoint |
Requirements |
Allows escalation of technical issues. |
Comments | |
MessageHeader.source.contact.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MessageHeader.source.contact.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* ? |
Type | Extension |
Aliases | 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. |
MessageHeader.source.contact.system | |
Definition |
Telecommunications form for contact point - what communications system is required to make use of the contact. |
Control | 0..1 ? |
Binding |
Telecommunications form for contact point The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-system |
Type | Code |
Comments |
Note that FHIR strings may not exceed 1MB in size |
MessageHeader.source.contact.value | |
Definition |
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Control | 0..1 ? |
Type | String |
Requirements |
Need to support legacy numbers that are not in a tightly controlled format. |
Comments |
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
MessageHeader.source.contact.use | |
Definition |
Identifies the purpose for the contact point. |
Control | 0..1 ? |
Binding |
Use of contact point The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-use |
Type | Code |
Is Modifier | True |
Requirements |
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments |
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
MessageHeader.source.contact.rank | |
Definition |
Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values. |
Control | 0..1 ? |
Type | PositiveInt |
Comments |
Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
MessageHeader.source.contact.period | |
Definition |
Time period when the contact point was/is in use. |
Control | 0..1 ? |
Type | Period |
Comments |
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
MessageHeader.source.contact.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MessageHeader.source.contact.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* ? |
Type | Extension |
Aliases | 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. |
MessageHeader.source.contact.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
MessageHeader.source.contact.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
MessageHeader.source.endpoint | |
Definition |
Identifies the routing target to send acknowledgements to. |
Control | 1..1 ? |
Type | Uri |
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. |
MessageHeader.responsible | |
Definition | |
Control | 1..* |
Type | https://fhir.nhs.uk/StructureDefinition/CareConnect-DCH-Organization-1 |
Comments | |
MessageHeader.responsible.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MessageHeader.responsible.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* ? |
Type | Extension |
Aliases | 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. |
MessageHeader.responsible.reference | |
Definition | |
Control | 1..* |
Comments | |
MessageHeader.responsible.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
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. |
MessageHeader.data | |
Definition | |
Control | 1..1 |
Type | https://fhir.nhs.uk/StructureDefinition/CareConnect-DCH-Encounter-1 |
Comments | |
MessageHeader.data.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
MessageHeader.data.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* ? |
Type | Extension |
Aliases | 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. |
MessageHeader.data.reference | |
Definition | |
Control | 1..* |
Comments | |
MessageHeader.data.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
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. |