US Public Health Profiles Library
2.0.0 - STU2
US Public Health Profiles Library
2.0.0 - STU2
US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-composition | Version: 2.0.0 | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: USPublicHealthComposition | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.7 | ||||
This Composition profile represents a public health composition.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation 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 | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   extension:extensionVersionNumber |
S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 extension:extensionInformationRecipient |
S | 0..* | Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization) | Information Recipient URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-information-recipient-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 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 |
 identifier |
SΣ | 1..1 | Identifier | Public Health Composition identifier ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 1..1 | CodeableConcept | Type of this public health report Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. ele-1: All FHIR elements must have a @value or children |
 subject |
SΣ | 1..1 | Reference(US Public Health Patient) | Patient ele-1: All FHIR elements must have a @value or children |
| encounter |
SΣ | 1..1 | Reference(US Public Health Encounter) | Encounter related to the public health event ele-1: All FHIR elements must have a @value or children |
| date |
SΣ | 1..1 | dateTime | Composition editing time ele-1: All FHIR elements must have a @value or children |
| author |
SΣ | 1..* | Reference(US Public Health PractitionerRole | US Core Practitioner Profile | US Public Health Organization | Device) | The author(s) of the document ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 1..1 | string | Human Readable name/title ele-1: All FHIR elements must have a @value or children |
| custodian |
SΣ | 0..1 | Reference(US Public Health Organization) | Organization which maintains the composition ele-1: All FHIR elements must have a @value or children |
  Slices for relatesTo |
S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code ele-1: All FHIR elements must have a @value or children |
   relatesTo:All Slices |
Content/Rules for all slices | |||
 modifierExtension |
?!Σ | 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 |
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. ele-1: All FHIR elements must have a @value or children | |
  target[x] |
1..1 | Target of the relationship ele-1: All FHIR elements must have a @value or children | ||
| targetIdentifier |
Identifier | |||
 targetReference |
Reference(Composition) | |||
| relatesTo:transformed |
S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?!Σ | 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 |
| code |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. ele-1: All FHIR elements must have a @value or children Fixed Value: transforms |
 target[x] |
S | 1..1 | Identifier | Identifier of the Document or Composition transformed ele-1: All FHIR elements must have a @value or children |
| relatesTo:replaced |
S | 0..1 | BackboneElement | Document or Composition that this Composition replaces ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 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 |
| code |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. ele-1: All FHIR elements must have a @value or children Fixed Value: replaces |
 target[x] |
S | 1..1 | Identifier/Reference to the Document or Composition transformed ele-1: All FHIR elements must have a @value or children | |
| targetIdentifier |
Identifier | |||
| targetReference |
Reference(Composition) | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | |
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | |
| Composition.relatesTo:transformed.code | required | Fixed Value: transformshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | |
| Composition.relatesTo:replaced.code | required | Fixed Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard |
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition |
Composition | |||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:extensionVersionNumber |
S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber |
| extension:extensionInformationRecipient |
S | 0..* | Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization) | Information Recipient URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-information-recipient-extension |
| identifier |
S | 1..1 | Identifier | Public Health Composition identifier |
| status |
S | 1..1 | code | preliminary | final | amended | entered-in-error |
| type |
S | 1..1 | CodeableConcept | Type of this public health report |
| subject |
S | 1..1 | Reference(US Public Health Patient) | Patient |
| encounter |
S | 1..1 | Reference(US Public Health Encounter) | Encounter related to the public health event |
| date |
S | 1..1 | dateTime | Composition editing time |
| author |
S | 1..* | Reference(US Public Health PractitionerRole | US Core Practitioner Profile | US Public Health Organization | Device) | The author(s) of the document |
| title |
S | 1..1 | string | Human Readable name/title |
| custodian |
S | 0..1 | Reference(US Public Health Organization) | Organization which maintains the composition |
| Slices for relatesTo |
S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code |
| relatesTo:transformed |
S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from |
| code |
S | 1..1 | code | replaces | transforms | signs | appends Fixed Value: transforms |
| target[x] |
S | 1..1 | Identifier | Identifier of the Document or Composition transformed |
| relatesTo:replaced |
S | 0..1 | BackboneElement | Document or Composition that this Composition replaces |
| code |
S | 1..1 | code | replaces | transforms | signs | appends Fixed Value: replaces |
| target[x] |
S | 1..1 | Identifier, Reference(Composition) | Identifier/Reference to the Document or Composition transformed |
| 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 | |||||
| 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:extensionVersionNumber |
S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber | ||||
| extension:extensionInformationRecipient |
S | 0..* | Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization) | Information Recipient URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-information-recipient-extension | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..1 | Identifier | Public Health Composition identifier | ||||
| status |
?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type |
SΣ | 1..1 | CodeableConcept | Type of this public health report Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
| 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(US Public Health Patient) | Patient | ||||
| encounter |
SΣ | 1..1 | Reference(US Public Health Encounter) | Encounter related to the public health event | ||||
| date |
SΣ | 1..1 | dateTime | Composition editing time | ||||
| author |
SΣ | 1..* | Reference(US Public Health PractitionerRole | US Core Practitioner Profile | US Public Health Organization | Device) | The author(s) of the document | ||||
| title |
SΣ | 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 |
SΣ | 0..1 | Reference(US Public Health Organization) | Organization which maintains the composition | ||||
| Slices for relatesTo |
S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code | ||||
| relatesTo:All Slices |
Content/Rules for all slices | |||||||
| 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) | |||||||
| relatesTo:transformed |
S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from | ||||
| 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 |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: transforms | ||||
| target[x] |
S | 1..1 | Identifier | Identifier of the Document or Composition transformed | ||||
| relatesTo:replaced |
S | 0..1 | BackboneElement | Document or Composition that this Composition replaces | ||||
| 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 |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: replaces | ||||
| target[x] |
S | 1..1 | Identifier/Reference to the Document or Composition transformed | |||||
| 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: ActCode (3.0.0) (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 |
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 | ||||
| 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 | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| 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. | |||||
| entry |
C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| 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 | URI | |||
| Composition.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26from the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo:transformed.code | required | Fixed Value: transformshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo:replaced.code | required | Fixed Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0 | ||||
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
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:
Maturity: 3
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 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 | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:extensionVersionNumber |
S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension:extensionInformationRecipient |
S | 0..* | Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization) | Information Recipient URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-information-recipient-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?! | 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 |
| identifier |
SΣ | 1..1 | Identifier | Public Health Composition identifier ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 1..1 | CodeableConcept | Type of this public health report Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. ele-1: All FHIR elements must have a @value or children |
| subject |
SΣ | 1..1 | Reference(US Public Health Patient) | Patient ele-1: All FHIR elements must have a @value or children |
| encounter |
SΣ | 1..1 | Reference(US Public Health Encounter) | Encounter related to the public health event ele-1: All FHIR elements must have a @value or children |
| date |
SΣ | 1..1 | dateTime | Composition editing time ele-1: All FHIR elements must have a @value or children |
| author |
SΣ | 1..* | Reference(US Public Health PractitionerRole | US Core Practitioner Profile | US Public Health Organization | Device) | The author(s) of the document ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 1..1 | string | Human Readable name/title ele-1: All FHIR elements must have a @value or children |
| custodian |
SΣ | 0..1 | Reference(US Public Health Organization) | Organization which maintains the composition ele-1: All FHIR elements must have a @value or children |
| Slices for relatesTo |
S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code ele-1: All FHIR elements must have a @value or children |
| relatesTo:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 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 |
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. ele-1: All FHIR elements must have a @value or children | |
| target[x] |
1..1 | Target of the relationship ele-1: All FHIR elements must have a @value or children | ||
| targetIdentifier |
Identifier | |||
| targetReference |
Reference(Composition) | |||
| relatesTo:transformed |
S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 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 |
| code |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. ele-1: All FHIR elements must have a @value or children Fixed Value: transforms |
| target[x] |
S | 1..1 | Identifier | Identifier of the Document or Composition transformed ele-1: All FHIR elements must have a @value or children |
| relatesTo:replaced |
S | 0..1 | BackboneElement | Document or Composition that this Composition replaces ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 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 |
| code |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. ele-1: All FHIR elements must have a @value or children Fixed Value: replaces |
| target[x] |
S | 1..1 | Identifier/Reference to the Document or Composition transformed ele-1: All FHIR elements must have a @value or children | |
| targetIdentifier |
Identifier | |||
| targetReference |
Reference(Composition) | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | |
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | |
| Composition.relatesTo:transformed.code | required | Fixed Value: transformshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | |
| Composition.relatesTo:replaced.code | required | Fixed Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard |
Differential View
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition |
Composition | |||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:extensionVersionNumber |
S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber |
| extension:extensionInformationRecipient |
S | 0..* | Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization) | Information Recipient URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-information-recipient-extension |
| identifier |
S | 1..1 | Identifier | Public Health Composition identifier |
| status |
S | 1..1 | code | preliminary | final | amended | entered-in-error |
| type |
S | 1..1 | CodeableConcept | Type of this public health report |
| subject |
S | 1..1 | Reference(US Public Health Patient) | Patient |
| encounter |
S | 1..1 | Reference(US Public Health Encounter) | Encounter related to the public health event |
| date |
S | 1..1 | dateTime | Composition editing time |
| author |
S | 1..* | Reference(US Public Health PractitionerRole | US Core Practitioner Profile | US Public Health Organization | Device) | The author(s) of the document |
| title |
S | 1..1 | string | Human Readable name/title |
| custodian |
S | 0..1 | Reference(US Public Health Organization) | Organization which maintains the composition |
| Slices for relatesTo |
S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code |
| relatesTo:transformed |
S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from |
| code |
S | 1..1 | code | replaces | transforms | signs | appends Fixed Value: transforms |
| target[x] |
S | 1..1 | Identifier | Identifier of the Document or Composition transformed |
| relatesTo:replaced |
S | 0..1 | BackboneElement | Document or Composition that this Composition replaces |
| code |
S | 1..1 | code | replaces | transforms | signs | appends Fixed Value: replaces |
| target[x] |
S | 1..1 | Identifier, Reference(Composition) | Identifier/Reference to the Document or Composition transformed |
| Documentation for this format | ||||
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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:extensionVersionNumber |
S | 1..1 | string | Public Health Composition versionNumber URL: http://hl7.org/fhir/StructureDefinition/composition-clinicaldocument-versionNumber | ||||
| extension:extensionInformationRecipient |
S | 0..* | Reference(US Core Practitioner Profile | US Public Health PractitionerRole | US Public Health Organization) | Information Recipient URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-information-recipient-extension | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..1 | Identifier | Public Health Composition identifier | ||||
| status |
?!SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type |
SΣ | 1..1 | CodeableConcept | Type of this public health report Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
| 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(US Public Health Patient) | Patient | ||||
| encounter |
SΣ | 1..1 | Reference(US Public Health Encounter) | Encounter related to the public health event | ||||
| date |
SΣ | 1..1 | dateTime | Composition editing time | ||||
| author |
SΣ | 1..* | Reference(US Public Health PractitionerRole | US Core Practitioner Profile | US Public Health Organization | Device) | The author(s) of the document | ||||
| title |
SΣ | 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 |
SΣ | 0..1 | Reference(US Public Health Organization) | Organization which maintains the composition | ||||
| Slices for relatesTo |
S | 0..* | BackboneElement | Relationships to other compositions/documents Slice: Unordered, Open by value:code | ||||
| relatesTo:All Slices |
Content/Rules for all slices | |||||||
| 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) | |||||||
| relatesTo:transformed |
S | 0..1 | BackboneElement | Document or Composition that this Composition is transformed from | ||||
| 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 |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: transforms | ||||
| target[x] |
S | 1..1 | Identifier | Identifier of the Document or Composition transformed | ||||
| relatesTo:replaced |
S | 0..1 | BackboneElement | Document or Composition that this Composition replaces | ||||
| 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 |
S | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Fixed Value: replaces | ||||
| target[x] |
S | 1..1 | Identifier/Reference to the Document or Composition transformed | |||||
| 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: ActCode (3.0.0) (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 |
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 | ||||
| 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 | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| 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. | |||||
| entry |
C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| 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 | URI | |||
| Composition.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | ||||
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesfrom the FHIR Standard | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26from the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo:transformed.code | required | Fixed Value: transformshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.relatesTo:replaced.code | required | Fixed Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1from the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0 | ||||
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
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:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 International / Public Health. Package hl7.fhir.us.ph-library#2.0.0 based on FHIR 4.0.1. Generated 2025-05-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change