| Package | openehr.base |
| Type | StructureDefinition |
| Id | COMPOSITION |
| FHIR Version | R5 |
| Source | http://openehr.org/fhir/https://build.fhir.org/ig/FHIR/openehr-base-ig/StructureDefinition-COMPOSITION.html |
| URL | http://openehr.org/fhir/StructureDefinition/COMPOSITION |
| Version | 0.1.0 |
| Status | active |
| Date | 2024-12-31T18:45:58+10:00 |
| Name | COMPOSITION |
| Title | COMPOSITION |
| Realm | uv |
| Authority | hl7 |
| Description | Content of one version in a VERSIONED_COMPOSITION. A Composition is considered the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians. In this latter sense, it may be considered equivalent to a signed document. NOTE: It is strongly recommended that the inherited attribute uid be populated in Compositions, using the UID copied from the object_id() of the uid field of the enclosing VERSION object. For example, the ORIGINAL_VERSION.uid 87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2 would be copied to the uid field of the Composition. |
| Type | http://openehr.org/fhir/StructureDefinition/COMPOSITION |
| Kind | logical |
No resources found
| StructureDefinition | |
| CODE-PHRASE | CODE_PHRASE |
| CONTENT-ITEM | CONTENT_ITEM |
| DV-CODED-TEXT | DV_CODED_TEXT |
| EVENT-CONTEXT | EVENT_CONTEXT |
| LOCATABLE | LOCATABLE |
| PARTY-PROXY | PARTY_PROXY |
| ValueSet | |
| valueset-composition_category | Composition Category |
| valueset-territories | Territories |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition COMPOSITION
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  COMPOSITION | 0..* | LOCATABLE | Elements defined in Ancestors:name, archetype_node_id, uid, links, archetype_details, feeder_audit, name, archetype_node_id, uid, links, archetype_details, feeder_audit One version in a VERSIONED_COMPOSITION: the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians | |
  language | 1..1 | CODE_PHRASE | Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages Binding: AllLanguages (required) | |
| territory | 1..1 | CODE_PHRASE | Name of territory in which this Composition was written. Coded from the ISO 3166 standard Binding: Territories (required) | |
| category | 1..1 | DV_CODED_TEXT | Temporal category of this Composition, e.g. * 431|persistent|, 451|episodic|, or 433|event| Binding: Composition Category (required) | |
| context | 0..1 | EVENT_CONTEXT | The clinical session context of this Composition, i.e. the contextual attributes of the clinical session | |
| composer | 1..1 | PARTY_PROXY | The person primarily responsible for the content of the Composition. This is the identifier which should appear on the screen | |
 content | 0..* | CONTENT_ITEM | The content of this Composition | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "COMPOSITION",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/web-source",
"valueUrl": "https://specifications.openehr.org/releases/RM/development/ehr.html#_composition_class"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
"valueCode": "element-view-replace-cardinality"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
}
],
"url": "http://openehr.org/fhir/StructureDefinition/COMPOSITION",
"version": "0.1.0",
"name": "COMPOSITION",
"title": "COMPOSITION",
"status": "active",
"experimental": false,
"date": "2024-12-31T18:45:58+10:00",
"publisher": "openEHR + HL7",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.openehr.org"
}
]
}
],
"description": "Content of one version in a VERSIONED_COMPOSITION. A Composition is considered the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians. In this latter sense, it may be considered equivalent to a signed document. NOTE: It is strongly recommended that the inherited attribute uid be populated in Compositions, using the UID copied from the object_id() of the uid field of the enclosing VERSION object. For example, the ORIGINAL_VERSION.uid 87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2 would be copied to the uid field of the Composition.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://openehr.org/fhir/StructureDefinition/COMPOSITION",
"baseDefinition": "http://openehr.org/fhir/StructureDefinition/LOCATABLE",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.1.0"
}
],
"element": [
{
"id": "COMPOSITION",
"path": "COMPOSITION",
"short": "One version in a VERSIONED_COMPOSITION: the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians",
"definition": "Content of one version in a VERSIONED_COMPOSITION. A Composition is considered the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians. In this latter sense, it may be considered equivalent to a signed document.",
"comment": "NOTE: It is strongly recommended that the inherited attribute uid be populated in Compositions, using the UID copied from the object_id() of the uid field of the enclosing VERSION object. For example, the ORIGINAL_VERSION.uid 87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2 would be copied to the uid field of the Composition.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "COMPOSITION.name",
"path": "COMPOSITION.name",
"short": "Runtime name of this fragment, used to build runtime paths",
"definition": "This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.",
"min": 1,
"max": "1",
"base": {
"path": "PATHABLE.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-TEXT"
}
],
"isModifier": false
},
{
"id": "COMPOSITION.archetype-node-id",
"path": "COMPOSITION.archetype_node_id",
"short": "Design-time archetype identifier of this node taken from its generating archetype",
"definition": "Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. at0005. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.",
"comment": "At an archetype root point, the value of this attribute is always the stringified form of the archetype_id found in the archetype_details object.",
"min": 1,
"max": "1",
"base": {
"path": "PATHABLE.archetype_node_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"id": "COMPOSITION.uid",
"path": "COMPOSITION.uid",
"short": "Optional globally unique object identifier for root points of archetyped structures",
"definition": "Optional globally unique object identifier for root points of archetyped structures.",
"min": 0,
"max": "1",
"base": {
"path": "PATHABLE.uid",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/UID-BASED-ID"
}
],
"isModifier": false
},
{
"id": "COMPOSITION.links",
"path": "COMPOSITION.links",
"short": "Links to other archetyped structures",
"definition": "Links to other archetyped structures (data whose root object inherits from ARCHETYPED, such as ENTRY, SECTION and so on). Links may be to structures in other compositions.",
"min": 0,
"max": "*",
"base": {
"path": "PATHABLE.links",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/LINK"
}
],
"isModifier": false
},
{
"id": "COMPOSITION.archetype-details",
"path": "COMPOSITION.archetype_details",
"short": "Details of archetyping used on this node",
"definition": "Details of archetyping used on this node.",
"min": 0,
"max": "1",
"base": {
"path": "PATHABLE.archetype_details",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/ARCHETYPED"
}
],
"isModifier": false
},
{
"id": "COMPOSITION.feeder-audit",
"path": "COMPOSITION.feeder_audit",
"short": "Audit trail from non-openEHR system of original commit of information forming the content of this node",
"definition": "Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.",
"min": 0,
"max": "1",
"base": {
"path": "PATHABLE.feeder_audit",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT"
}
],
"isModifier": false
},
{
"id": "COMPOSITION.language",
"path": "COMPOSITION.language",
"short": "Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages",
"definition": "Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages. The language of an Entry if different from the Composition is indicated in ENTRY.language.",
"min": 1,
"max": "1",
"base": {
"path": "COMPOSITION.language",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
}
],
"isModifier": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"id": "COMPOSITION.territory",
"path": "COMPOSITION.territory",
"short": "Name of territory in which this Composition was written. Coded from the ISO 3166 standard",
"definition": "Name of territory in which this Composition was written. Coded from openEHR countries code set, which is an expression of the ISO 3166 standard.",
"min": 1,
"max": "1",
"base": {
"path": "COMPOSITION.territory",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
}
],
"isModifier": false,
"binding": {
"strength": "required",
"valueSet": "https://specifications.openehr.org/fhir/valueset-territories"
}
},
{
"id": "COMPOSITION.category",
"path": "COMPOSITION.category",
"short": "Temporal category of this Composition, e.g. * 431|persistent|, 451|episodic|, or 433|event|",
"definition": "Temporal category of this Composition, i.e.\r\n\r\n* 431|persistent| - of potential life-time validity;* 451|episodic| - valid over the life of a care episode;* 433|event| - valid at the time of recording (long-term validity requires subsequent clinical assessment).\r\n\r\nor any other code defined in the openEHR terminology group 'category'.",
"min": 1,
"max": "1",
"base": {
"path": "COMPOSITION.category",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT"
}
],
"isModifier": false,
"binding": {
"strength": "required",
"valueSet": "https://specifications.openehr.org/fhir/valueset-composition_category"
}
},
{
"id": "COMPOSITION.context",
"path": "COMPOSITION.context",
"short": "The clinical session context of this Composition, i.e. the contextual attributes of the clinical session",
"definition": "The clinical session context of this Composition, i.e. the contextual attributes of the clinical session.",
"min": 0,
"max": "1",
"base": {
"path": "COMPOSITION.context",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/EVENT-CONTEXT"
}
],
"isModifier": false
},
{
"id": "COMPOSITION.composer",
"path": "COMPOSITION.composer",
"short": "The person primarily responsible for the content of the Composition. This is the identifier which should appear on the screen",
"definition": "The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). This is the identifier which should appear on the screen. It may or may not be the person who entered the data. When it is the patient, the special self instance of PARTY_PROXY will be used.",
"min": 1,
"max": "1",
"base": {
"path": "COMPOSITION.composer",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/PARTY-PROXY"
}
],
"isModifier": false
},
{
"id": "COMPOSITION.content",
"path": "COMPOSITION.content",
"short": "The content of this Composition",
"definition": "The content of this Composition.",
"min": 0,
"max": "*",
"base": {
"path": "COMPOSITION.content",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/CONTENT-ITEM"
}
],
"isModifier": false
}
]
},
"differential": {
"element": [
{
"id": "COMPOSITION",
"path": "COMPOSITION",
"short": "One version in a VERSIONED_COMPOSITION: the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians",
"definition": "Content of one version in a VERSIONED_COMPOSITION. A Composition is considered the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians. In this latter sense, it may be considered equivalent to a signed document.",
"comment": "NOTE: It is strongly recommended that the inherited attribute uid be populated in Compositions, using the UID copied from the object_id() of the uid field of the enclosing VERSION object. For example, the ORIGINAL_VERSION.uid 87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2 would be copied to the uid field of the Composition.",
"min": 0,
"max": "*",
"isModifier": false
},
{
"id": "COMPOSITION.language",
"path": "COMPOSITION.language",
"short": "Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages",
"definition": "Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages. The language of an Entry if different from the Composition is indicated in ENTRY.language.",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
}
],
"isModifier": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"id": "COMPOSITION.territory",
"path": "COMPOSITION.territory",
"short": "Name of territory in which this Composition was written. Coded from the ISO 3166 standard",
"definition": "Name of territory in which this Composition was written. Coded from openEHR countries code set, which is an expression of the ISO 3166 standard.",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
}
],
"isModifier": false,
"binding": {
"strength": "required",
"valueSet": "https://specifications.openehr.org/fhir/valueset-territories"
}
},
{
"id": "COMPOSITION.category",
"path": "COMPOSITION.category",
"short": "Temporal category of this Composition, e.g. * 431|persistent|, 451|episodic|, or 433|event|",
"definition": "Temporal category of this Composition, i.e.\r\n\r\n* 431|persistent| - of potential life-time validity;* 451|episodic| - valid over the life of a care episode;* 433|event| - valid at the time of recording (long-term validity requires subsequent clinical assessment).\r\n\r\nor any other code defined in the openEHR terminology group 'category'.",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT"
}
],
"isModifier": false,
"binding": {
"strength": "required",
"valueSet": "https://specifications.openehr.org/fhir/valueset-composition_category"
}
},
{
"id": "COMPOSITION.context",
"path": "COMPOSITION.context",
"short": "The clinical session context of this Composition, i.e. the contextual attributes of the clinical session",
"definition": "The clinical session context of this Composition, i.e. the contextual attributes of the clinical session.",
"min": 0,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/EVENT-CONTEXT"
}
],
"isModifier": false
},
{
"id": "COMPOSITION.composer",
"path": "COMPOSITION.composer",
"short": "The person primarily responsible for the content of the Composition. This is the identifier which should appear on the screen",
"definition": "The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). This is the identifier which should appear on the screen. It may or may not be the person who entered the data. When it is the patient, the special self instance of PARTY_PROXY will be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/PARTY-PROXY"
}
],
"isModifier": false
},
{
"id": "COMPOSITION.content",
"path": "COMPOSITION.content",
"short": "The content of this Composition",
"definition": "The content of this Composition.",
"min": 0,
"max": "*",
"type": [
{
"code": "http://openehr.org/fhir/StructureDefinition/CONTENT-ITEM"
}
],
"isModifier": false
}
]
}
}