GPConnect-CareRecord-Composition-1
Composition | |
Definition |
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. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained. |
Control | 1..1 |
Type | Composition |
Comments |
While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical. |
Composition.date | |
Definition |
The composition editing time, when the composition was last logically changed by the author. |
Control | 1..1 |
Type | DateTime |
Requirements |
dateTime is used for tracking, organizing versions and searching. |
Comments |
The Last Modified Date on the composition may be after the date of the document was attested without being changed. |
Composition.type | |
Definition |
Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition. |
Control | 1..1 |
Binding |
Type of a composition. The codes SHALL be taken from http://fhir.nhs.net/ValueSet/document-type-codes-snct-1 |
Type | CodeableConcept |
Requirements |
Key metadata element describing the composition, used in searching/filtering. |
Comments |
For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding. |
Composition.type.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..1 |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments |
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
Composition.type.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | Uri |
Requirements |
Need to be unambiguous about the source of the definition of the symbol. |
Comments |
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://snomed.info/sct |
Composition.type.coding.code | |
Definition |
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments | |
Fixed Value | 425173008 |
Composition.type.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Fixed Value | record extract (record artifact) |
Composition.type.text | |
Definition |
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 |
Type | String |
Requirements |
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
Fixed Value | record extract (record artifact) |
Composition.class | |
Definition |
A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type. |
Control | 0..1 |
Binding |
Type of a care setting. The codes SHALL be taken from http://fhir.nhs.net/ValueSet/care-setting-codes-snct-1 |
Type | CodeableConcept |
Requirements |
Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. |
Comments |
This is a metadata field from XDS/MHD. |
Composition.class.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..1 |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments |
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
Composition.class.coding.system | |
Definition |
The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | Uri |
Requirements |
Need to be unambiguous about the source of the definition of the symbol. |
Comments |
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://snomed.info/sct |
Composition.class.coding.code | |
Definition |
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | Code |
Requirements |
Need to refer to a particular code in the system. |
Comments | |
Fixed Value | 700232004 |
Composition.class.coding.display | |
Definition |
A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | String |
Requirements |
Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Fixed Value | general medical service (qualifier value) |
Composition.class.text | |
Definition |
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 |
Type | String |
Requirements |
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
Fixed Value | general medical service (qualifier value) |
Composition.title | |
Definition |
Official human-readable label for the composition. |
Control | 1..1 |
Type | String |
Comments |
For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period. |
Fixed Value | Patient Care Record |
Composition.status | |
Definition |
The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. This should be set to 'Final' as it will reflect the most up-to-date version of the Patient's Record held at the GP Practice. |
Control | 1..1 |
Binding |
The workflow/clinical status of the composition. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/composition-status |
Type | Code |
Is Modifier | True |
Requirements |
Need to be able to mark interim, amended, or withdrawn compositions or documents. |
Comments |
If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "withdrawn" is why this element is labeled as a modifier of other elements. Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required. |
Fixed Value | final |
Composition.confidentiality | |
Definition |
The code specifying the level of confidentiality of the Composition. |
Control | 0..1 |
Binding |
Codes specifying the level of confidentiality of the composition. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/v3-Confidentiality |
Type | Code |
Is Modifier | True |
Comments |
The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). |
Composition.subject | |
Definition |
The Patient this composition is about |
Control | 1..1 |
Requirements |
Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about. |
Comments |
For clinical documents, this is usually the patient. |
Composition.subject.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Example | Patient/31686b67-9f20-4644-9a54-193d2f91de57 |
Composition.subject.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Example | Sally Taylor |
Composition.author | |
Definition |
Identifies who is responsible for the information in the composition, not necessarily who typed it in. |
Control | 1..1 |
Requirements |
Identifies who is responsible for the content. |
Comments | |
Composition.custodian | |
Definition |
Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information |
Control | 0..1 |
Requirements |
Identifies where to go to find the current version, where to report issues, etc. |
Comments |
This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However it is important that this information be known when working with a derived document, so providing a custodian is encouraged. |
Composition.custodian.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Example | Organization/79600119-ebaf-4362-bb89-d473a33b1675 |
Composition.custodian.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Example | Wood Town GP Practice |