This page is part of the Vital Records Birth and Fetal Death Reporting (v1.1.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Composition-coded-race-and-ethnicity | Version: 1.1.0 | |||
Active as of 2023-10-10 | Computable Name: CompositionCodedRaceAndEthnicity |
This Composition profile communicates coded race and ethnicity information to the appropriate jurisdictional Vital Records Office.
It contains data that are a coded form of the race and ethnicity data that has been submitted to the the national statistics agency.
Two sets of codes will be used to address two objectives. These objectives are:
In addition, when the coding process has led to duplication of data, the duplicates will be eliminated.
Coded race and ethnicity data is communicated for both the mother and father in the case of live birth and only for the mother in the case of fetal death.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Composition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
fetalDeathReportNumber | S | 0..1 | Identifier | Extension URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-fetal-death-report-number |
liveBirthCertificateNumber | S | 0..1 | Identifier | Extension URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-live-birth-certificate-number |
type | S | 1..1 | CodeableConcept | Race and ethnicity information Document Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |
subject | S | 1..1 | Reference(Patient - Child - Vital Records | Patient - Decedent Fetus - Vital Records) | Who and/or what the composition is about |
author | S | 1..1 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The author is the NCHS. |
section | S | 2..2 | BackboneElement | Coded race and ethnicity section. |
code | 0..1 | CodeableConcept | Race and ethnicity information Document Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |
focus | S | 1..1 | Reference(Patient - Mother - Vital Records | RelatedPerson - Father Natural - Vital Records) | The focus of this section is the mother or father |
Slices for entry | S | 2..* | Reference(Resource) | Entries that are contained in the Coded Race and Ethnicity section Slice: Unordered, Open by profile:$this.resolve() |
entry:race | S | 1..1 | Reference(Observation - Race - Vital Records) | Tabulated race |
entry:tabulatedEthnicity | S | 1..1 | Reference(Observation - Tabulated Ethnicity - Vital Records) | Tabulated ethnicity |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
fetalDeathReportNumber | S | 0..1 | Identifier | Extension URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-fetal-death-report-number |
liveBirthCertificateNumber | S | 0..1 | Identifier | Extension URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-live-birth-certificate-number |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
type | SΣ | 1..1 | CodeableConcept | Race and ethnicity information Document Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |
subject | SΣ | 1..1 | Reference(Patient - Child - Vital Records | Patient - Decedent Fetus - Vital Records) | Who and/or what the composition is about |
date | Σ | 1..1 | dateTime | Composition editing time |
author | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The author is the NCHS. |
title | Σ | 1..1 | string | Human Readable name/title |
section | SC | 2..2 | BackboneElement | Coded race and ethnicity section. |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 0..1 | CodeableConcept | Race and ethnicity information Document Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |
focus | S | 1..1 | Reference(Patient - Mother - Vital Records | RelatedPerson - Father Natural - Vital Records) | The focus of this section is the mother or father |
Slices for entry | SC | 2..* | Reference(Resource) | Entries that are contained in the Coded Race and Ethnicity section Slice: Unordered, Open by profile:$this.resolve() |
entry:race | SC | 1..1 | Reference(Observation - Race - Vital Records) | Tabulated race |
entry:tabulatedEthnicity | SC | 1..1 | Reference(Observation - Tabulated Ethnicity - Vital Records) | Tabulated ethnicity |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Composition.status | required | CompositionStatus |
Composition.type | preferred | Pattern: LOINC code 86805-9 |
Composition.section.code | example | Pattern: LOINC code 86805-9 |
Id | Grade | Path(s) | Details | Requirements |
cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
fetalDeathReportNumber | S | 0..1 | Identifier | Extension URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-fetal-death-report-number | ||||
liveBirthCertificateNumber | S | 0..1 | Identifier | Extension URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-live-birth-certificate-number | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..1 | Identifier | Version-independent identifier for the Composition | ||||
status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
type | SΣ | 1..1 | CodeableConcept | Race and ethnicity information Document Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
category | Σ | 0..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
subject | SΣ | 1..1 | Reference(Patient - Child - Vital Records | Patient - Decedent Fetus - Vital Records) | Who and/or what the composition is about | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition | ||||
date | Σ | 1..1 | dateTime | Composition editing time | ||||
author | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The author is the NCHS. | ||||
title | Σ | 1..1 | string | Human Readable name/title | ||||
confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
attester | 0..* | BackboneElement | Attests to accuracy of composition | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
time | 0..1 | dateTime | When the composition was attested | |||||
party | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
custodian | Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
relatesTo | 0..* | BackboneElement | Relationships to other compositions/documents | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
target[x] | 1..1 | Target of the relationship | ||||||
targetIdentifier | Identifier | |||||||
targetReference | Reference(Composition) | |||||||
event | Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
period | Σ | 0..1 | Period | The period covered by the documentation | ||||
detail | Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
section | SC | 2..2 | BackboneElement | Coded race and ethnicity section. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | 0..1 | string | Label for section (e.g. for ToC) | |||||
code | 0..1 | CodeableConcept | Race and ethnicity information Document Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
focus | S | 1..1 | Reference(Patient - Mother - Vital Records | RelatedPerson - Father Natural - Vital Records) | The focus of this section is the mother or father | ||||
text | C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
Slices for entry | SC | 2..* | Reference(Resource) | Entries that are contained in the Coded Race and Ethnicity section Slice: Unordered, Open by profile:$this.resolve() | ||||
entry:race | SC | 1..1 | Reference(Observation - Race - Vital Records) | Tabulated race | ||||
entry:tabulatedEthnicity | SC | 1..1 | Reference(Observation - Tabulated Ethnicity - Vital Records) | Tabulated ethnicity | ||||
emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
section | C | 0..* | See section (Composition) | Nested Section | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Composition.language | preferred | CommonLanguages
| ||||
Composition.status | required | CompositionStatus | ||||
Composition.type | preferred | Pattern: LOINC code 86805-9 | ||||
Composition.category | example | DocumentClassValueSet | ||||
Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
Composition.attester.mode | required | CompositionAttestationMode | ||||
Composition.relatesTo.code | required | DocumentRelationshipType | ||||
Composition.event.code | example | ActCode | ||||
Composition.section.code | example | Pattern: LOINC code 86805-9 | ||||
Composition.section.mode | required | ListMode | ||||
Composition.section.orderedBy | preferred | ListOrderCodes | ||||
Composition.section.emptyReason | preferred | ListEmptyReasons |
Id | Grade | Path(s) | Details | Requirements |
cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Composition
Summary
Mandatory: 5 elements
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Composition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
fetalDeathReportNumber | S | 0..1 | Identifier | Extension URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-fetal-death-report-number |
liveBirthCertificateNumber | S | 0..1 | Identifier | Extension URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-live-birth-certificate-number |
type | S | 1..1 | CodeableConcept | Race and ethnicity information Document Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |
subject | S | 1..1 | Reference(Patient - Child - Vital Records | Patient - Decedent Fetus - Vital Records) | Who and/or what the composition is about |
author | S | 1..1 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The author is the NCHS. |
section | S | 2..2 | BackboneElement | Coded race and ethnicity section. |
code | 0..1 | CodeableConcept | Race and ethnicity information Document Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |
focus | S | 1..1 | Reference(Patient - Mother - Vital Records | RelatedPerson - Father Natural - Vital Records) | The focus of this section is the mother or father |
Slices for entry | S | 2..* | Reference(Resource) | Entries that are contained in the Coded Race and Ethnicity section Slice: Unordered, Open by profile:$this.resolve() |
entry:race | S | 1..1 | Reference(Observation - Race - Vital Records) | Tabulated race |
entry:tabulatedEthnicity | S | 1..1 | Reference(Observation - Tabulated Ethnicity - Vital Records) | Tabulated ethnicity |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
fetalDeathReportNumber | S | 0..1 | Identifier | Extension URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-fetal-death-report-number |
liveBirthCertificateNumber | S | 0..1 | Identifier | Extension URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-live-birth-certificate-number |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
type | SΣ | 1..1 | CodeableConcept | Race and ethnicity information Document Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |
subject | SΣ | 1..1 | Reference(Patient - Child - Vital Records | Patient - Decedent Fetus - Vital Records) | Who and/or what the composition is about |
date | Σ | 1..1 | dateTime | Composition editing time |
author | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The author is the NCHS. |
title | Σ | 1..1 | string | Human Readable name/title |
section | SC | 2..2 | BackboneElement | Coded race and ethnicity section. |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 0..1 | CodeableConcept | Race and ethnicity information Document Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |
focus | S | 1..1 | Reference(Patient - Mother - Vital Records | RelatedPerson - Father Natural - Vital Records) | The focus of this section is the mother or father |
Slices for entry | SC | 2..* | Reference(Resource) | Entries that are contained in the Coded Race and Ethnicity section Slice: Unordered, Open by profile:$this.resolve() |
entry:race | SC | 1..1 | Reference(Observation - Race - Vital Records) | Tabulated race |
entry:tabulatedEthnicity | SC | 1..1 | Reference(Observation - Tabulated Ethnicity - Vital Records) | Tabulated ethnicity |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Composition.status | required | CompositionStatus |
Composition.type | preferred | Pattern: LOINC code 86805-9 |
Composition.section.code | example | Pattern: LOINC code 86805-9 |
Id | Grade | Path(s) | Details | Requirements |
cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
fetalDeathReportNumber | S | 0..1 | Identifier | Extension URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-fetal-death-report-number | ||||
liveBirthCertificateNumber | S | 0..1 | Identifier | Extension URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-live-birth-certificate-number | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..1 | Identifier | Version-independent identifier for the Composition | ||||
status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
type | SΣ | 1..1 | CodeableConcept | Race and ethnicity information Document Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
category | Σ | 0..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
subject | SΣ | 1..1 | Reference(Patient - Child - Vital Records | Patient - Decedent Fetus - Vital Records) | Who and/or what the composition is about | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition | ||||
date | Σ | 1..1 | dateTime | Composition editing time | ||||
author | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | The author is the NCHS. | ||||
title | Σ | 1..1 | string | Human Readable name/title | ||||
confidentiality | Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
attester | 0..* | BackboneElement | Attests to accuracy of composition | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | 1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
time | 0..1 | dateTime | When the composition was attested | |||||
party | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
custodian | Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
relatesTo | 0..* | BackboneElement | Relationships to other compositions/documents | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
target[x] | 1..1 | Target of the relationship | ||||||
targetIdentifier | Identifier | |||||||
targetReference | Reference(Composition) | |||||||
event | Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
period | Σ | 0..1 | Period | The period covered by the documentation | ||||
detail | Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
section | SC | 2..2 | BackboneElement | Coded race and ethnicity section. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
title | 0..1 | string | Label for section (e.g. for ToC) | |||||
code | 0..1 | CodeableConcept | Race and ethnicity information Document Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 86805-9 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
author | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
focus | S | 1..1 | Reference(Patient - Mother - Vital Records | RelatedPerson - Father Natural - Vital Records) | The focus of this section is the mother or father | ||||
text | C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
mode | 0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
Slices for entry | SC | 2..* | Reference(Resource) | Entries that are contained in the Coded Race and Ethnicity section Slice: Unordered, Open by profile:$this.resolve() | ||||
entry:race | SC | 1..1 | Reference(Observation - Race - Vital Records) | Tabulated race | ||||
entry:tabulatedEthnicity | SC | 1..1 | Reference(Observation - Tabulated Ethnicity - Vital Records) | Tabulated ethnicity | ||||
emptyReason | C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
section | C | 0..* | See section (Composition) | Nested Section | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Composition.language | preferred | CommonLanguages
| ||||
Composition.status | required | CompositionStatus | ||||
Composition.type | preferred | Pattern: LOINC code 86805-9 | ||||
Composition.category | example | DocumentClassValueSet | ||||
Composition.confidentiality | required | v3.ConfidentialityClassification | ||||
Composition.attester.mode | required | CompositionAttestationMode | ||||
Composition.relatesTo.code | required | DocumentRelationshipType | ||||
Composition.event.code | example | ActCode | ||||
Composition.section.code | example | Pattern: LOINC code 86805-9 | ||||
Composition.section.mode | required | ListMode | ||||
Composition.section.orderedBy | preferred | ListOrderCodes | ||||
Composition.section.emptyReason | preferred | ListEmptyReasons |
Id | Grade | Path(s) | Details | Requirements |
cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Composition
Summary
Mandatory: 5 elements
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron