Birth Defects Reporting - STU1
0.1.2 - draft
Birth Defects Reporting - STU1, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 0.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-birthdefectsreporting-ig/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/birthdefectreporting/StructureDefinition/bdr-messageheader | Version: 0.1.2 | |||
Draft as of 2025-02-11 | Computable Name: BDRMessageHeader |
The message header for the birth defect report.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: Birth Defect Report Event Types (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message destination application(s) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual destination address or id ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message source application ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual message source address or id ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..* | Reference(Condition - Reportable Diagnosis) | The actual content of the message ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x] | required | EventTypeshttp://hl7.org/fhir/us/birthdefectreporting/ValueSet/bdr-eventtypes from this IG |
This structure is derived from MessageHeader
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
MessageHeader | |||
![]() ![]() ![]() |
1..1 | Coding | Code for the event this message represents or link to event definition Binding: Birth Defect Report Event Types (required) | |
![]() ![]() ![]() |
1..1 | BackboneElement | Message destination application(s) | |
![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | |
![]() ![]() ![]() |
1..* | Reference(Condition - Reportable Diagnosis) | The actual content of the message | |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x] | required | EventTypeshttp://hl7.org/fhir/us/birthdefectreporting/ValueSet/bdr-eventtypes from this IG |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: Birth Defect Report Event Types (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message destination application(s) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual destination address or id | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message source application | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of software running the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of software running | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | Human contact for problems | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual message source address or id | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | id | Id of original message | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
![]() ![]() ![]() |
Σ | 1..* | Reference(Condition - Reportable Diagnosis) | The actual content of the message | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MessageHeader.event[x] | required | EventTypeshttp://hl7.org/fhir/us/birthdefectreporting/ValueSet/bdr-eventtypes from this IG | ||||
MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounter from the FHIR Standard | ||||
MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1 from the FHIR Standard |
This structure is derived from MessageHeader
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: Birth Defect Report Event Types (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message destination application(s) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual destination address or id ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message source application ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual message source address or id ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..* | Reference(Condition - Reportable Diagnosis) | The actual content of the message ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x] | required | EventTypeshttp://hl7.org/fhir/us/birthdefectreporting/ValueSet/bdr-eventtypes from this IG |
Differential View
This structure is derived from MessageHeader
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
MessageHeader | |||
![]() ![]() ![]() |
1..1 | Coding | Code for the event this message represents or link to event definition Binding: Birth Defect Report Event Types (required) | |
![]() ![]() ![]() |
1..1 | BackboneElement | Message destination application(s) | |
![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | |
![]() ![]() ![]() |
1..* | Reference(Condition - Reportable Diagnosis) | The actual content of the message | |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x] | required | EventTypeshttp://hl7.org/fhir/us/birthdefectreporting/ValueSet/bdr-eventtypes from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: Birth Defect Report Event Types (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message destination application(s) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual destination address or id | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message source application | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of software running the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of software running | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | Human contact for problems | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual message source address or id | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | id | Id of original message | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
![]() ![]() ![]() |
Σ | 1..* | Reference(Condition - Reportable Diagnosis) | The actual content of the message | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
MessageHeader.event[x] | required | EventTypeshttp://hl7.org/fhir/us/birthdefectreporting/ValueSet/bdr-eventtypes from this IG | ||||
MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounter from the FHIR Standard | ||||
MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1 from the FHIR Standard |
This structure is derived from MessageHeader
Other representations of profile: CSV, Excel, Schematron