Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/Virtually-Healthcare-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir.virtually.healthcare/StructureDefinition/Composition | Version: 0.1.0-current | |||
| Draft as of 2024-11-06 | Computable Name: Composition | |||
Extension of UKCore-Composition
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from UKCoreComposition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition |
0..* | UKCoreComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition |
0..* | UKCoreComposition | 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 |
Content/Rules for all slices | |||
   careSettingType |
N | 0..1 | CodeableConcept | The type of care setting associated with a composition or a list. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType Binding: UK Core Care Setting Type (preferred): Correspondence care setting type |
 modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| 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 | Kind of composition (SNOMED CT) Binding: UK Core Document Type (preferred): SNOMED CT Document Type |
 subject |
SΣC | 0..1 | Reference(Resource) | Who and/or what the composition is about ref-1: SHALL have a contained resource if a local reference is provided |
| date |
Σ | 1..1 | dateTime | Composition editing time |
| author |
SΣC | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition ref-1: SHALL have a contained resource if a local reference is provided |
| title |
Σ | 1..1 | string | Human Readable name/title |
| confidentiality |
SΣ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. |
 custodian |
SΣC | 0..1 | Reference(Organization) | Organization which maintains the composition ref-1: SHALL have a contained resource if a local reference is provided |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | |
| Composition.type | preferred | UKCoreDocumentTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-DocumentType | |
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | UKCoreComposition | 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| careSettingType |
N | 0..1 | CodeableConcept | The type of care setting associated with a composition or a list. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType Binding: UK Core Care Setting Type (preferred): Correspondence care setting type | ||||
| modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier |
Σ | 0..1 | Identifier | Version-independent identifier for the Composition | ||||
| 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 | Kind of composition (SNOMED CT) Binding: UK Core Document Type (preferred): SNOMED CT Document Type | ||||
| category |
Σ | 0..* | CodeableConcept | Categorization of Composition Binding: UK Core Composition Category (preferred): A ValueSet to identify the category of a composition. | ||||
| subject |
SΣC | 0..1 | Reference(Resource) | Who and/or what the composition is about ref-1: SHALL have a contained resource if a local reference is provided | ||||
| encounter |
ΣC | 0..1 | Reference(Encounter) | Context of the Composition ref-1: SHALL have a contained resource if a local reference is provided | ||||
| date |
Σ | 1..1 | dateTime | Composition editing time | ||||
| author |
SΣC | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition ref-1: SHALL have a contained resource if a local reference is provided | ||||
| title |
Σ | 1..1 | string | Human Readable name/title | ||||
| confidentiality |
SΣ | 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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 |
C | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition ref-1: SHALL have a contained resource if a local reference is provided | ||||
| custodian |
SΣC | 0..1 | Reference(Organization) | Organization which maintains the composition ref-1: SHALL have a contained resource if a local reference is provided | ||||
| relatesTo |
0..* | BackboneElement | Relationships to other compositions/documents | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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 |
ΣC | 0..1 | Period | The period covered by the documentation per-1: If present, start SHALL have a lower value than end | ||||
| detail |
ΣC | 0..* | Reference(Resource) | The event(s) being documented ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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: UK Core Composition Section Code (extensible): Classification of a section of a composition/document. | |||||
| author |
C | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section ref-1: SHALL have a contained resource if a local reference is provided | ||||
| focus |
C | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 | 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.0.1from the FHIR Standard | ||||
| Composition.type | preferred | UKCoreDocumentTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-DocumentType | ||||
| Composition.category | preferred | UKCoreCompositionCategoryhttps://fhir.hl7.org.uk/ValueSet/UKCore-CompositionCategory | ||||
| 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.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | extensible | UKCoreCompositionSectionCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-CompositionSectionCode | ||||
| 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 UKCoreComposition
Differential View
This structure is derived from UKCoreComposition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition |
0..* | UKCoreComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition |
0..* | UKCoreComposition | 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 |
Content/Rules for all slices | |||
| careSettingType |
N | 0..1 | CodeableConcept | The type of care setting associated with a composition or a list. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType Binding: UK Core Care Setting Type (preferred): Correspondence care setting type |
| modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| 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 | Kind of composition (SNOMED CT) Binding: UK Core Document Type (preferred): SNOMED CT Document Type |
| subject |
SΣC | 0..1 | Reference(Resource) | Who and/or what the composition is about ref-1: SHALL have a contained resource if a local reference is provided |
| date |
Σ | 1..1 | dateTime | Composition editing time |
| author |
SΣC | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition ref-1: SHALL have a contained resource if a local reference is provided |
| title |
Σ | 1..1 | string | Human Readable name/title |
| confidentiality |
SΣ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. |
| custodian |
SΣC | 0..1 | Reference(Organization) | Organization which maintains the composition ref-1: SHALL have a contained resource if a local reference is provided |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1from the FHIR Standard | |
| Composition.type | preferred | UKCoreDocumentTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-DocumentType | |
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | UKCoreComposition | 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| careSettingType |
N | 0..1 | CodeableConcept | The type of care setting associated with a composition or a list. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType Binding: UK Core Care Setting Type (preferred): Correspondence care setting type | ||||
| modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| identifier |
Σ | 0..1 | Identifier | Version-independent identifier for the Composition | ||||
| 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 | Kind of composition (SNOMED CT) Binding: UK Core Document Type (preferred): SNOMED CT Document Type | ||||
| category |
Σ | 0..* | CodeableConcept | Categorization of Composition Binding: UK Core Composition Category (preferred): A ValueSet to identify the category of a composition. | ||||
| subject |
SΣC | 0..1 | Reference(Resource) | Who and/or what the composition is about ref-1: SHALL have a contained resource if a local reference is provided | ||||
| encounter |
ΣC | 0..1 | Reference(Encounter) | Context of the Composition ref-1: SHALL have a contained resource if a local reference is provided | ||||
| date |
Σ | 1..1 | dateTime | Composition editing time | ||||
| author |
SΣC | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition ref-1: SHALL have a contained resource if a local reference is provided | ||||
| title |
Σ | 1..1 | string | Human Readable name/title | ||||
| confidentiality |
SΣ | 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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 |
C | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition ref-1: SHALL have a contained resource if a local reference is provided | ||||
| custodian |
SΣC | 0..1 | Reference(Organization) | Organization which maintains the composition ref-1: SHALL have a contained resource if a local reference is provided | ||||
| relatesTo |
0..* | BackboneElement | Relationships to other compositions/documents | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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 |
ΣC | 0..1 | Period | The period covered by the documentation per-1: If present, start SHALL have a lower value than end | ||||
| detail |
ΣC | 0..* | Reference(Resource) | The event(s) being documented ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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: UK Core Composition Section Code (extensible): Classification of a section of a composition/document. | |||||
| author |
C | 0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section ref-1: SHALL have a contained resource if a local reference is provided | ||||
| focus |
C | 0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 ref-1: SHALL have a contained resource if a local reference is provided | ||||
| 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 | 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.0.1from the FHIR Standard | ||||
| Composition.type | preferred | UKCoreDocumentTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-DocumentType | ||||
| Composition.category | preferred | UKCoreCompositionCategoryhttps://fhir.hl7.org.uk/ValueSet/UKCore-CompositionCategory | ||||
| 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.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| Composition.section.code | extensible | UKCoreCompositionSectionCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-CompositionSectionCode | ||||
| 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 UKCoreComposition
Other representations of profile: CSV, Excel, Schematron