INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
StructureDefinition: CareConnect-Composition-1
A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement.
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Composition-1
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Composition
Summary
Mandatory: 0 element (2 nested mandatory elements)
Structures
This structure refers to these other structures:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Composition-1
Extensions
This structure refers to these extensions:
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition | I | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 Extension-CareConnect-CareSettingType-1 | I | 0..1 | CodeableConcept | An extension to carry the Care setting type of the document URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-CareSettingType-1 |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | Σ | 0..1 | Identifier | Logical identifier of composition (version-independent) |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
  assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required) |
| type | Σ | 1..1 | CodeableConcept | Kind of composition (SNOMED CT) Binding: Care Connect Document Type (preferred) |
| class | Σ | 0..1 | CodeableConcept | Categorization of Composition Binding: FHIR Document Class Codes (example) |
| subject | Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about |
| encounter | Σ | 0..1 | Reference(CareConnect-Encounter-1) | Context of the Composition |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | Σ | 1..* | Reference(Device | RelatedPerson | CareConnect-Practitioner-1 | CareConnect-Patient-1) | Who and/or what authored the composition |
| title | Σ | 1..1 | string | Human Readable name/title |
| confidentiality | ?!Σ | 0..1 | code | As defined by affinity domain Binding: ConfidentialityClassification (required) |
| attester | ΣI | 0..* | BackboneElement | Attests to accuracy of composition |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| mode | Σ | 1..* | code | personal | professional | legal | official Binding: CompositionAttestationMode (required) |
| time | Σ | 0..1 | dateTime | When the composition was attested |
| party | Σ | 0..1 | Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-Patient-1) | Who attested the composition |
| custodian | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization which maintains the composition |
| relatesTo | ΣI | 0..1 | BackboneElement | Relationships to other compositions/documents |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
  target[x] | Σ | 1..1 | Target of the relationship | |
 targetIdentifier | Identifier | |||
| targetReference | Reference(CareConnect-Composition-1) | |||
| event | ΣI | 0..* | BackboneElement | The clinical service(s) being documented |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: ActCode (example) |
| period | Σ | 0..1 | Period | The period covered by the documentation |
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented |
| section | I | 0..* | BackboneElement | Composition is broken into sections cmp-1: A section must 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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| title | 0..1 | string | Label for section (e.g. for ToC) | |
| code | 0..1 | CodeableConcept | Classification of section (recommended) Binding: Care Connect Composition Section Code (preferred) | |
| text | I | 0..1 | Narrative | Text summary of the section, for human interpretation |
| mode | ?!Σ | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: List Order Codes (preferred) | |
| entry | I | 0..* | Reference(Resource) | A reference to data that supports this section |
| emptyReason | I | 0..1 | CodeableConcept | Why the section is empty Binding: List Empty Reasons (preferred) |
 section | I | 0..* | Unknown reference to #Composition.section Nested Section | |
| Documentation for this format | ||||
This structure is derived from Composition
Summary
Mandatory: 0 element (2 nested mandatory elements)
Structures
This structure refers to these other structures:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Composition-1
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Composition
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | I | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-CareConnect-CareSettingType-1 | I | 0..1 | CodeableConcept | An extension to carry the Care setting type of the document URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-CareSettingType-1 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Logical identifier of composition (version-independent) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required) |
| type | Σ | 1..1 | CodeableConcept | Kind of composition (SNOMED CT) Binding: Care Connect Document Type (preferred) |
| class | Σ | 0..1 | CodeableConcept | Categorization of Composition Binding: FHIR Document Class Codes (example) |
| subject | Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about |
| encounter | Σ | 0..1 | Reference(CareConnect-Encounter-1) | Context of the Composition |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | Σ | 1..* | Reference(Device | RelatedPerson | CareConnect-Practitioner-1 | CareConnect-Patient-1) | Who and/or what authored the composition |
| title | Σ | 1..1 | string | Human Readable name/title |
| confidentiality | ?!Σ | 0..1 | code | As defined by affinity domain Binding: ConfidentialityClassification (required) |
| attester | ΣI | 0..* | BackboneElement | Attests to accuracy of composition |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| mode | Σ | 1..* | code | personal | professional | legal | official Binding: CompositionAttestationMode (required) |
| time | Σ | 0..1 | dateTime | When the composition was attested |
| party | Σ | 0..1 | Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-Patient-1) | Who attested the composition |
| custodian | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization which maintains the composition |
| relatesTo | ΣI | 0..1 | BackboneElement | Relationships to other compositions/documents |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
| target[x] | Σ | 1..1 | Target of the relationship | |
| targetIdentifier | Identifier | |||
| targetReference | Reference(CareConnect-Composition-1) | |||
| event | ΣI | 0..* | BackboneElement | The clinical service(s) being documented |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: ActCode (example) |
| period | Σ | 0..1 | Period | The period covered by the documentation |
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented |
| section | I | 0..* | BackboneElement | Composition is broken into sections cmp-1: A section must 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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| title | 0..1 | string | Label for section (e.g. for ToC) | |
| code | 0..1 | CodeableConcept | Classification of section (recommended) Binding: Care Connect Composition Section Code (preferred) | |
| text | I | 0..1 | Narrative | Text summary of the section, for human interpretation |
| mode | ?!Σ | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: List Order Codes (preferred) | |
| entry | I | 0..* | Reference(Resource) | A reference to data that supports this section |
| emptyReason | I | 0..1 | CodeableConcept | Why the section is empty Binding: List Empty Reasons (preferred) |
| section | I | 0..* | Unknown reference to #Composition.section Nested Section | |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Composition.language | extensible | Common Languages Max Binding: All Languages |
| Composition.identifier.use | required | IdentifierUse |
| Composition.identifier.type | extensible | Identifier Type Codes |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | Care Connect Document Type |
| Composition.class | example | FHIR Document Class Codes |
| Composition.confidentiality | required | ConfidentialityClassification |
| Composition.attester.mode | required | CompositionAttestationMode |
| Composition.relatesTo.code | required | DocumentRelationshipType |
| Composition.event.code | example | v3 Code System ActCode |
| Composition.section.code | preferred | Care Connect Composition Section Code |
| Composition.section.mode | required | ListMode |
| Composition.section.orderedBy | preferred | List Order Codes |
| Composition.section.emptyReason | preferred | List Empty Reasons |
Constraints
Constraints
| Id | Path | Details | Requirements |
| dom-2 | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Composition | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | 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-3 | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ele-1 | Composition.extension:careSettingTypeExtension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Composition.extension:careSettingTypeExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Composition.attester | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Composition.relatesTo | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Composition.event | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Composition.section | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| cmp-1 | Composition.section | A section must at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() |