SPL Mapping FHIR Implementation Guide
0.1.0 - Build CI
SPL Mapping FHIR Implementation Guide
0.1.0 - Build CI
SPL Mapping FHIR Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/ProductSubmissionDocument | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: ProductSubmissionDocument | ||
A profile that represents a document that is required for Product Submission to the FDA.
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 |
Composition | |||
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 versionNumber |
S | 1..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/versionNumber |
 identifier |
S | 1..1 | Identifier | Version-independent identifier for the Composition |
| type |
S | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: SPL Document Codes (required) |
 author |
S | 1..1 | Reference(IdentifiedLabeler) | Who and/or what authored the composition |
| title |
S | 1..1 | string | Human Readable name/title |
  Slices for section |
S | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code |
  section:All Slices |
Content/Rules for all slices | |||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| title |
S | 0..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: SPL Section Codes (required) |
| text |
S | 0..1 | Narrative | Text summary of the section, for human interpretation |
| entry |
S | 0..* | Reference(Resource) | A reference to data that supports this section |
  section |
S | 0..* | BackboneElement | Nested Section |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| title |
S | 0..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: SPL Section Codes (required) |
| text |
S | 0..1 | Narrative | Text summary of the section, for human interpretation |
 entry |
0..0 | |||
| section:ProductSection |
0..1 | BackboneElement | Composition is broken into sections | |
 sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| title |
0..0 | |||
 code |
0..1 | CodeableConcept | Classification of section (recommended) 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: 48780-1 | |
| entry |
1..* | Reference(SubmittedMedicinalProduct) | A reference to data that supports this section | |
 section |
0..0 | |||
| section:LabelDisplay |
0..* | BackboneElement | Composition is broken into sections | |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| code |
0..1 | CodeableConcept | Classification of section (recommended) 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: 51945-4 | |
| text |
1..1 | Narrative | Text summary of the section, for human interpretation | |
| entry |
0..0 | |||
| section |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Composition.type | required | SPLDocumentCodeshttp://hl7.org/fhir/us/spl/ValueSet/splDocumentCodesfrom this IG | |
| Composition.section.code | required | SPLSectionCodeshttp://hl7.org/fhir/us/spl/ValueSet/splSectionCodesfrom this IG | |
| Composition.section.section.code | required | SPLSectionCodeshttp://hl7.org/fhir/us/spl/ValueSet/splSectionCodesfrom this IG |
| 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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| versionNumber |
S | 1..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/versionNumber |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..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 | Kind of composition (LOINC if possible) Binding: SPL Document Codes (required) |
| date |
Σ | 1..1 | dateTime | Composition editing time |
| author |
SΣ | 1..1 | Reference(IdentifiedLabeler) | Who and/or what authored the composition |
| title |
SΣ | 1..1 | string | Human Readable name/title |
| Slices for section |
SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code 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 |
| section:All Slices |
Content/Rules for all slices | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title |
S | 0..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: SPL Section Codes (required) |
| text |
SC | 0..1 | Narrative | Text summary of the section, for human interpretation |
| entry |
SC | 0..* | Reference(Resource) | A reference to data that supports this section |
| section |
SC | 0..* | BackboneElement | Nested Section |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title |
S | 0..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: SPL Section Codes (required) |
| text |
SC | 0..1 | Narrative | Text summary of the section, for human interpretation |
| section:ProductSection |
C | 0..1 | 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 |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
0..1 | CodeableConcept | Classification of section (recommended) 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: 48780-1 | |
| entry |
C | 1..* | Reference(SubmittedMedicinalProduct) | A reference to data that supports this section |
| section:LabelDisplay |
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 |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
0..1 | CodeableConcept | Classification of section (recommended) 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: 51945-4 | |
| text |
C | 1..1 | Narrative | Text summary of the section, for human interpretation |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.3.0from the FHIR Standard | |
| Composition.type | required | SPLDocumentCodeshttp://hl7.org/fhir/us/spl/ValueSet/splDocumentCodesfrom this IG | |
| Composition.section.code | required | SPLSectionCodeshttp://hl7.org/fhir/us/spl/ValueSet/splSectionCodesfrom this IG | |
| Composition.section.section.code | required | SPLSectionCodeshttp://hl7.org/fhir/us/spl/ValueSet/splSectionCodesfrom this IG | |
| Composition.section:ProductSection.code | example | Pattern: LOINC code 48780-1http://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | |
| Composition.section:LabelDisplay.code | example | Pattern: LOINC code 51945-4http://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:ProductSection, Composition.section:LabelDisplay | 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, Composition.section:ProductSection, Composition.section:LabelDisplay | 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.exists() and ('#'+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(uri) = '#').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): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| versionNumber |
S | 1..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/versionNumber | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..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 | Kind of composition (LOINC if possible) Binding: SPL Document Codes (required) | ||||
| category |
Σ | 0..* | CodeableConcept | Categorization of Composition Binding: LoincDocumentOntologyInternational (example): High-level kind of a clinical document at a macro level. | ||||
| subject |
Σ | 0..1 | Reference(Resource) | 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(IdentifiedLabeler) | Who and/or what authored the composition | ||||
| title |
SΣ | 1..1 | string | Human Readable name/title | ||||
| confidentiality |
Σ | 0..1 | code | As defined by affinity domain Binding: http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 (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 | ||||
| Slices for section |
SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code 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 | ||||
| section:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime | ||||
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title |
S | 0..1 | string | Label for section (e.g. for ToC) | ||||
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: SPL Section Codes (required) | ||||
| 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 |
SC | 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 |
SC | 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 |
SC | 0..* | BackboneElement | Nested Section | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime | ||||
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title |
S | 0..1 | string | Label for section (e.g. for ToC) | ||||
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: SPL Section Codes (required) | ||||
| 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 |
SC | 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. | |||||
| 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 | ||||
| section:ProductSection |
C | 0..1 | 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime | ||||
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
0..1 | CodeableConcept | Classification of section (recommended) 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: 48780-1 | |||||
| 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 |
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 | 1..* | Reference(SubmittedMedicinalProduct) | 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:LabelDisplay |
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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime | ||||
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId | ||||
| 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. 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: 51945-4 | |||||
| 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 |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 1..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. | |||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.3.0from the FHIR Standard | ||||
| Composition.type | required | SPLDocumentCodeshttp://hl7.org/fhir/us/spl/ValueSet/splDocumentCodesfrom this IG | ||||
| Composition.category | example | LoincDocumentOntologyInternationalhttp://terminology.hl7.org/ValueSet/v3-LoincDocumentOntologyInternational | ||||
| Composition.confidentiality | required | http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.3.0from the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.3.0from the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | required | SPLSectionCodeshttp://hl7.org/fhir/us/spl/ValueSet/splSectionCodesfrom this IG | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from 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 | ||||
| Composition.section.section.code | required | SPLSectionCodeshttp://hl7.org/fhir/us/spl/ValueSet/splSectionCodesfrom this IG | ||||
| Composition.section.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | ||||
| Composition.section.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:ProductSection.code | example | Pattern: LOINC code 48780-1http://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section:ProductSection.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | ||||
| Composition.section:ProductSection.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:ProductSection.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:ProductSection.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section:ProductSection.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | ||||
| Composition.section:ProductSection.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:ProductSection.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:LabelDisplay.code | example | Pattern: LOINC code 51945-4http://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section:LabelDisplay.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | ||||
| Composition.section:LabelDisplay.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:LabelDisplay.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:LabelDisplay.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section:LabelDisplay.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | ||||
| Composition.section:LabelDisplay.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:LabelDisplay.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:ProductSection, Composition.section:LabelDisplay | 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, Composition.section:ProductSection, Composition.section:LabelDisplay | 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.exists() and ('#'+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(uri) = '#').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() | |
| dom-r4b | warning | Composition.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
| 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(3 nested mandatory elements)
Must-Support: 26 elements
Prohibited: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
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 | |
| versionNumber |
S | 1..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/versionNumber |
| identifier |
S | 1..1 | Identifier | Version-independent identifier for the Composition |
| type |
S | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: SPL Document Codes (required) |
| author |
S | 1..1 | Reference(IdentifiedLabeler) | Who and/or what authored the composition |
| title |
S | 1..1 | string | Human Readable name/title |
| Slices for section |
S | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code |
| section:All Slices |
Content/Rules for all slices | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| title |
S | 0..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: SPL Section Codes (required) |
| text |
S | 0..1 | Narrative | Text summary of the section, for human interpretation |
| entry |
S | 0..* | Reference(Resource) | A reference to data that supports this section |
| section |
S | 0..* | BackboneElement | Nested Section |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| title |
S | 0..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: SPL Section Codes (required) |
| text |
S | 0..1 | Narrative | Text summary of the section, for human interpretation |
| entry |
0..0 | |||
| section:ProductSection |
0..1 | BackboneElement | Composition is broken into sections | |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| title |
0..0 | |||
| code |
0..1 | CodeableConcept | Classification of section (recommended) 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: 48780-1 | |
| entry |
1..* | Reference(SubmittedMedicinalProduct) | A reference to data that supports this section | |
| section |
0..0 | |||
| section:LabelDisplay |
0..* | BackboneElement | Composition is broken into sections | |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| code |
0..1 | CodeableConcept | Classification of section (recommended) 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: 51945-4 | |
| text |
1..1 | Narrative | Text summary of the section, for human interpretation | |
| entry |
0..0 | |||
| section |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Composition.type | required | SPLDocumentCodeshttp://hl7.org/fhir/us/spl/ValueSet/splDocumentCodesfrom this IG | |
| Composition.section.code | required | SPLSectionCodeshttp://hl7.org/fhir/us/spl/ValueSet/splSectionCodesfrom this IG | |
| Composition.section.section.code | required | SPLSectionCodeshttp://hl7.org/fhir/us/spl/ValueSet/splSectionCodesfrom this IG |
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 |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| versionNumber |
S | 1..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/versionNumber |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..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 | Kind of composition (LOINC if possible) Binding: SPL Document Codes (required) |
| date |
Σ | 1..1 | dateTime | Composition editing time |
| author |
SΣ | 1..1 | Reference(IdentifiedLabeler) | Who and/or what authored the composition |
| title |
SΣ | 1..1 | string | Human Readable name/title |
| Slices for section |
SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code 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 |
| section:All Slices |
Content/Rules for all slices | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title |
S | 0..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: SPL Section Codes (required) |
| text |
SC | 0..1 | Narrative | Text summary of the section, for human interpretation |
| entry |
SC | 0..* | Reference(Resource) | A reference to data that supports this section |
| section |
SC | 0..* | BackboneElement | Nested Section |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| title |
S | 0..1 | string | Label for section (e.g. for ToC) |
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: SPL Section Codes (required) |
| text |
SC | 0..1 | Narrative | Text summary of the section, for human interpretation |
| section:ProductSection |
C | 0..1 | 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 |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
0..1 | CodeableConcept | Classification of section (recommended) 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: 48780-1 | |
| entry |
C | 1..* | Reference(SubmittedMedicinalProduct) | A reference to data that supports this section |
| section:LabelDisplay |
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 |
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime |
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
0..1 | CodeableConcept | Classification of section (recommended) 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: 51945-4 | |
| text |
C | 1..1 | Narrative | Text summary of the section, for human interpretation |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.3.0from the FHIR Standard | |
| Composition.type | required | SPLDocumentCodeshttp://hl7.org/fhir/us/spl/ValueSet/splDocumentCodesfrom this IG | |
| Composition.section.code | required | SPLSectionCodeshttp://hl7.org/fhir/us/spl/ValueSet/splSectionCodesfrom this IG | |
| Composition.section.section.code | required | SPLSectionCodeshttp://hl7.org/fhir/us/spl/ValueSet/splSectionCodesfrom this IG | |
| Composition.section:ProductSection.code | example | Pattern: LOINC code 48780-1http://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | |
| Composition.section:LabelDisplay.code | example | Pattern: LOINC code 51945-4http://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:ProductSection, Composition.section:LabelDisplay | 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, Composition.section:ProductSection, Composition.section:LabelDisplay | 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.exists() and ('#'+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(uri) = '#').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): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| versionNumber |
S | 1..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/versionNumber | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..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 | Kind of composition (LOINC if possible) Binding: SPL Document Codes (required) | ||||
| category |
Σ | 0..* | CodeableConcept | Categorization of Composition Binding: LoincDocumentOntologyInternational (example): High-level kind of a clinical document at a macro level. | ||||
| subject |
Σ | 0..1 | Reference(Resource) | 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(IdentifiedLabeler) | Who and/or what authored the composition | ||||
| title |
SΣ | 1..1 | string | Human Readable name/title | ||||
| confidentiality |
Σ | 0..1 | code | As defined by affinity domain Binding: http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 (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 | ||||
| Slices for section |
SC | 1..* | BackboneElement | Composition is broken into sections Slice: Unordered, Open by value:code 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 | ||||
| section:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime | ||||
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title |
S | 0..1 | string | Label for section (e.g. for ToC) | ||||
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: SPL Section Codes (required) | ||||
| 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 |
SC | 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 |
SC | 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 |
SC | 0..* | BackboneElement | Nested Section | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime | ||||
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title |
S | 0..1 | string | Label for section (e.g. for ToC) | ||||
| code |
S | 1..1 | CodeableConcept | Classification of section (recommended) Binding: SPL Section Codes (required) | ||||
| 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 |
SC | 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. | |||||
| 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 | ||||
| section:ProductSection |
C | 0..1 | 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime | ||||
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
0..1 | CodeableConcept | Classification of section (recommended) 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: 48780-1 | |||||
| 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 |
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 | 1..* | Reference(SubmittedMedicinalProduct) | 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:LabelDisplay |
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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| sectionTime |
S | 0..1 | dateTime, Period | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionEffectiveTime | ||||
| linkId |
S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/spl/StructureDefinition/sectionLinkId | ||||
| 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. 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: 51945-4 | |||||
| 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 |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 1..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. | |||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.3.0from the FHIR Standard | ||||
| Composition.type | required | SPLDocumentCodeshttp://hl7.org/fhir/us/spl/ValueSet/splDocumentCodesfrom this IG | ||||
| Composition.category | example | LoincDocumentOntologyInternationalhttp://terminology.hl7.org/ValueSet/v3-LoincDocumentOntologyInternational | ||||
| Composition.confidentiality | required | http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.3.0from the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.3.0from the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | required | SPLSectionCodeshttp://hl7.org/fhir/us/spl/ValueSet/splSectionCodesfrom this IG | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from 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 | ||||
| Composition.section.section.code | required | SPLSectionCodeshttp://hl7.org/fhir/us/spl/ValueSet/splSectionCodesfrom this IG | ||||
| Composition.section.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | ||||
| Composition.section.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:ProductSection.code | example | Pattern: LOINC code 48780-1http://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section:ProductSection.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | ||||
| Composition.section:ProductSection.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:ProductSection.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:ProductSection.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section:ProductSection.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | ||||
| Composition.section:ProductSection.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:ProductSection.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:LabelDisplay.code | example | Pattern: LOINC code 51945-4http://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section:LabelDisplay.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | ||||
| Composition.section:LabelDisplay.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:LabelDisplay.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard | ||||
| Composition.section:LabelDisplay.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesfrom the FHIR Standard | ||||
| Composition.section:LabelDisplay.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.3.0from the FHIR Standard | ||||
| Composition.section:LabelDisplay.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| Composition.section:LabelDisplay.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:ProductSection, Composition.section:LabelDisplay | 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, Composition.section:ProductSection, Composition.section:LabelDisplay | 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.exists() and ('#'+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(uri) = '#').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() | |
| dom-r4b | warning | Composition.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
| 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(3 nested mandatory elements)
Must-Support: 26 elements
Prohibited: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Biomedical Research and Regulation. Package hl7.fhir.us.spl#0.1.0 based on FHIR 4.3.0. Generated 2024-05-02
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change