HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-composition | Version: 2.1.2 | |||
Active as of 2024-10-30 | Computable Name: USPublicHealthComposition | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.35 |
This Composition profile represents a public health composition.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Composition
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
S | 0..* | Composition | US Public Health Composition Profile |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(US Core Practitioner Profile(4.0.0) | US Public Health PractitionerRole | US Public Health Organization) | Information Recipient URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension |
![]() ![]() ![]() |
S | 1..1 | Identifier | Public Health Composition identifier |
![]() ![]() ![]() |
S | 1..1 | code | preliminary | final | amended | entered-in-error |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of this public health report |
![]() ![]() ![]() |
S | 1..1 | Reference(US Public Health Patient) | Patient |
![]() ![]() ![]() |
S | 1..1 | Reference(US Public Health Encounter) | Encounter related to the public health event |
![]() ![]() ![]() |
S | 1..1 | dateTime | Composition editing time |
![]() ![]() ![]() |
S | 1..* | Reference(US Public Health PractitionerRole | US Core Practitioner Profile(4.0.0) | US Public Health Organization | Device) | The author(s) of the document |
![]() ![]() ![]() |
S | 1..1 | string | Human Readable name/title |
![]() ![]() ![]() |
S | 0..1 | Reference(US Public Health Organization) | Organization which maintains the composition |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code |
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | replaces | transforms | signs | appends Fixed Value: transforms |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier of the Document or Composition transformed |
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Document or Composition that this Composition replaces |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | replaces | transforms | signs | appends Fixed Value: replaces |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier, Reference(Composition) | Identifier/Reference to the Document or Composition transformed |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
S | 0..* | Composition | US Public Health Composition Profile |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(US Core Practitioner Profile(4.0.0) | US Public Health PractitionerRole | US Public Health Organization) | Information Recipient URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Public Health Composition identifier |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of this public health report Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Public Health Patient) | Patient |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Public Health Encounter) | Encounter related to the public health event |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Composition editing time |
![]() ![]() ![]() |
SΣ | 1..* | Reference(US Public Health PractitionerRole | US Core Practitioner Profile(4.0.0) | US Public Health Organization | Device) | The author(s) of the document |
![]() ![]() ![]() |
SΣ | 1..1 | string | Human Readable name/title |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(US Public Health Organization) | Organization which maintains the composition |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Target of the relationship | ||
![]() ![]() ![]() ![]() ![]() ![]() |
Identifier | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Composition) | |||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: transforms |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier of the Document or Composition transformed |
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Document or Composition that this Composition replaces |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: replaces |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier/Reference to the Document or Composition transformed | |
![]() ![]() ![]() ![]() ![]() ![]() |
Identifier | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Composition) | |||
![]() |
Path | Conformance | ValueSet / Code | URI |
Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | |
Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | |
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | |
Composition.relatesTo:sliceTransformed.code | required | Fixed Value: transformshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | |
Composition.relatesTo:sliceReplaced.code | required | Fixed Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
S | 0..* | Composition | US Public Health Composition Profile | ||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber | ||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(US Core Practitioner Profile(4.0.0) | US Public Health PractitionerRole | US Public Health Organization) | Information Recipient URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Public Health Composition identifier | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of this public health report Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Public Health Patient) | Patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Public Health Encounter) | Encounter related to the public health event | ||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Composition editing time | ||||
![]() ![]() ![]() |
SΣ | 1..* | Reference(US Public Health PractitionerRole | US Core Practitioner Profile(4.0.0) | US Public Health Organization | Device) | The author(s) of the document | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Human Readable name/title | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Attests to accuracy of composition | |||||
![]() ![]() ![]() ![]() |
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 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When the composition was attested | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(US Public Health Organization) | Organization which maintains the composition | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Target of the relationship | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Composition) | |||||||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: transforms | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier of the Document or Composition transformed | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Document or Composition that this Composition replaces | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: replaces | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier/Reference to the Document or Composition transformed | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Composition) | |||||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
![]() ![]() ![]() ![]() |
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..* | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | The period covered by the documentation | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
![]() ![]() ![]() ![]() |
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 | Label for section (e.g. for ToC) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
![]() ![]() ![]() ![]() |
0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
![]() ![]() ![]() ![]() |
C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
![]() ![]() ![]() ![]() |
C | 0..* | See section (Composition) | Nested Section | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | ||||
Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard | ||||
Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo:sliceTransformed.code | required | Fixed Value: transformshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo:sliceReplaced.code | required | Fixed Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard |
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: 18 elements
Fixed: 2 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![]() |
---|---|---|---|---|
![]() ![]() |
S | 0..* | Composition | US Public Health Composition Profile |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(US Core Practitioner Profile(4.0.0) | US Public Health PractitionerRole | US Public Health Organization) | Information Recipient URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension |
![]() ![]() ![]() |
S | 1..1 | Identifier | Public Health Composition identifier |
![]() ![]() ![]() |
S | 1..1 | code | preliminary | final | amended | entered-in-error |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Type of this public health report |
![]() ![]() ![]() |
S | 1..1 | Reference(US Public Health Patient) | Patient |
![]() ![]() ![]() |
S | 1..1 | Reference(US Public Health Encounter) | Encounter related to the public health event |
![]() ![]() ![]() |
S | 1..1 | dateTime | Composition editing time |
![]() ![]() ![]() |
S | 1..* | Reference(US Public Health PractitionerRole | US Core Practitioner Profile(4.0.0) | US Public Health Organization | Device) | The author(s) of the document |
![]() ![]() ![]() |
S | 1..1 | string | Human Readable name/title |
![]() ![]() ![]() |
S | 0..1 | Reference(US Public Health Organization) | Organization which maintains the composition |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code |
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | replaces | transforms | signs | appends Fixed Value: transforms |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier of the Document or Composition transformed |
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Document or Composition that this Composition replaces |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | replaces | transforms | signs | appends Fixed Value: replaces |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier, Reference(Composition) | Identifier/Reference to the Document or Composition transformed |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
S | 0..* | Composition | US Public Health Composition Profile |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(US Core Practitioner Profile(4.0.0) | US Public Health PractitionerRole | US Public Health Organization) | Information Recipient URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Public Health Composition identifier |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of this public health report Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Public Health Patient) | Patient |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Public Health Encounter) | Encounter related to the public health event |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Composition editing time |
![]() ![]() ![]() |
SΣ | 1..* | Reference(US Public Health PractitionerRole | US Core Practitioner Profile(4.0.0) | US Public Health Organization | Device) | The author(s) of the document |
![]() ![]() ![]() |
SΣ | 1..1 | string | Human Readable name/title |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(US Public Health Organization) | Organization which maintains the composition |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Target of the relationship | ||
![]() ![]() ![]() ![]() ![]() ![]() |
Identifier | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Composition) | |||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: transforms |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier of the Document or Composition transformed |
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Document or Composition that this Composition replaces |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: replaces |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier/Reference to the Document or Composition transformed | |
![]() ![]() ![]() ![]() ![]() ![]() |
Identifier | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Composition) | |||
![]() |
Path | Conformance | ValueSet / Code | URI |
Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | |
Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | |
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | |
Composition.relatesTo:sliceTransformed.code | required | Fixed Value: transformshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | |
Composition.relatesTo:sliceReplaced.code | required | Fixed Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
S | 0..* | Composition | US Public Health Composition Profile | ||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber | ||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(US Core Practitioner Profile(4.0.0) | US Public Health PractitionerRole | US Public Health Organization) | Information Recipient URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-information-recipient-extension | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Public Health Composition identifier | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of this public health report Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Public Health Patient) | Patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Public Health Encounter) | Encounter related to the public health event | ||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Composition editing time | ||||
![]() ![]() ![]() |
SΣ | 1..* | Reference(US Public Health PractitionerRole | US Core Practitioner Profile(4.0.0) | US Public Health Organization | Device) | The author(s) of the document | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Human Readable name/title | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Attests to accuracy of composition | |||||
![]() ![]() ![]() ![]() |
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 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When the composition was attested | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(US Public Health Organization) | Organization which maintains the composition | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Target of the relationship | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Composition) | |||||||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: transforms | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier of the Document or Composition transformed | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Document or Composition that this Composition replaces | ||||
![]() ![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: replaces | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier/Reference to the Document or Composition transformed | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Reference(Composition) | |||||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
![]() ![]() ![]() ![]() |
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..* | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | The period covered by the documentation | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty | ||||
![]() ![]() ![]() ![]() |
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 | Label for section (e.g. for ToC) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Narrative | Text summary of the section, for human interpretation | ||||
![]() ![]() ![]() ![]() |
0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
![]() ![]() ![]() ![]() |
C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
![]() ![]() ![]() ![]() |
C | 0..* | See section (Composition) | Nested Section | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | ||||
Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard | ||||
Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26 from the FHIR Standard | ||||
Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo:sliceTransformed.code | required | Fixed Value: transformshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.relatesTo:sliceReplaced.code | required | Fixed Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codes from the FHIR Standard | ||||
Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard |
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: 18 elements
Fixed: 2 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
IG © 2020+ HL7 International / Public Health. Package hl7.fhir.us.ecr#2.1.2 based on FHIR 4.0.1. Generated 2024-10-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change