Notice
- Important: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
- This Implementation Guide is currently in Draft and SHOULD NOT be used for development or active implementation without express direction from the NHS England Genomics Unit.
StructureDefinition NHSEngland-Composition-GenomicsEULabReport
There are two use cases for Compositions within Genomics.
For Order Management, Compositions will be limited to documents generated by the central broker for capturing snapshots of Test orders and results in order to maintain historical accuracy, as per the DocumentReference generate OperationDefinition. These will typically form the first entry of a Document Bundle and as such will not be exposed via their own endpoint, nor allow creates, reads or updates from client systems on the resource itself.
Usage of the Compostion resource and generation of documents is pending internal review
To support cross border data sharing Compositions SHOULD be aligned to the HL7 EU Lab Composition profile as a wrap around structured reports.
For the Unified Genomic Record, Compositions will form the header or 'contents page' of the UGR itself. section elements will be used to emulate the UGR folders. CodeSystems/codes for the required sections of the UGR are currently under development.
| Profile url | FHIR Module | Normative Status |
|---|---|---|
| https://fhir.nhs.uk/StructureDefinition/NHSEngland-Composition-GenomicsEULabReport | NHS England Genomics | trial-use |
| Canonical_URL | Status | Current_Version | Last_Updated | Description |
|---|---|---|---|---|
| https://fhir.nhs.uk/StructureDefinition/NHSEngland-Composition-GenomicsEULabReport | active | 0.4.0 | 2026-07-15 | This profile defines the Genomics constraints and extensions on the EU Lab FHIR resource EU Lab Composition. |
Tree View
| NHSEngland_Composition_GenomicsEULabReport (Composition) | C | CompositionLabReportEu | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| version | C | 0..1 | Extension(string) |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueString | string | ||
| informationRecipient | C | 0..* | Extension(Reference(CareTeam | Device | Group | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)) |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | ||
| valueReference | Reference(OrganizationEuCore | PatientEuCore | PractitionerEuCore | PractitionerRoleEuCore | Device | RelatedPerson) | ||
| diagnosticReport | C | 0..1 | Extension(Reference(DiagnosticReport)) |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 1..1 | Reference(DiagnosticReport) | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 1..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| display | Σ | 0..1 | string |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | Σ | 1..1 | Identifier |
| status | Σ ?! | 1..1 | codeBindingFixed Value |
| type | Σ | 1..1 | CodeableConceptBinding |
| category | Σ | 0..* | CodeableConcept |
| studyType | Σ | 0..* | CodeableConceptBindingFixed Value |
| specialty | Σ | 0..* | CodeableConceptBindingFixed Value |
| subject | Σ C | 1..1 | Reference(LocationEuCore | PatientEuCore | Device | Group) |
| encounter | Σ C | 0..1 | Reference(Encounter) |
| date | Σ | 1..1 | dateTime |
| author | Σ C | 1..* | Reference(OrganizationEuCore | PatientEuCore | PractitionerEuCore | PractitionerRoleEuCore | Device | RelatedPerson) |
| title | Σ | 1..1 | stringFixed Value |
| confidentiality | Σ | 0..1 | codeBinding |
| attester | 0..* | BackboneElement | |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| mode | 1..1 | codeBinding | |
| time | 0..1 | dateTime | |
| party | C | 0..1 | Reference(OrganizationEuCore | PatientEuCore | PractitionerEuCore | PractitionerRoleEuCore | RelatedPerson) |
| legalAuthenticator | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| mode | 1..1 | codeBindingPattern | |
| time | 1..1 | dateTime | |
| party | C | 1..1 | Reference(PractitionerEuCore | PractitionerRoleEuCore) |
| validator | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| mode | 1..1 | codeBindingPattern | |
| time | 1..1 | dateTime | |
| party | C | 1..1 | Reference(PractitionerEuCore | PractitionerRoleEuCore) |
| custodian | Σ C | 0..1 | Reference(OrganizationEuCore) |
| relatesTo | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| code | 1..1 | codeBinding | |
| target[x] | 1..1 | ||
| targetIdentifier | Identifier | ||
| targetReference | Reference(Composition) | ||
| event | Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| code | Σ | 0..* | CodeableConcept |
| period | Σ C | 0..1 | Period |
| detail | Σ C | 0..* | Reference(Resource) |
| section | C | 1..* | BackboneElement |
| (All Slices) | |||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| section-note | C | 0..* | Extension(Annotation) |
| modifierExtension | Σ ?! C | 0..* | Extension |
| title | 1..1 | string | |
| code | 1..1 | CodeableConcept | |
| author | C | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| focus | C | 0..1 | Reference(Resource) |
| text | C | 1..1 | Narrative |
| mode | 0..1 | codeBinding | |
| orderedBy | 0..1 | CodeableConceptBinding | |
| entry | C | 0..* | Reference(Resource) |
| emptyReason | C | 0..1 | CodeableConceptBinding |
| section | C | 0..* | see (section) |
| annotations | C | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| section-note | C | 0..* | Extension(Annotation) |
| modifierExtension | Σ ?! C | 0..* | Extension |
| title | 1..1 | string | |
| code | 1..1 | CodeableConceptPattern | |
| author | C | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| focus | C | 0..1 | Reference(Resource) |
| text | C | 1..1 | Narrative |
| mode | 0..1 | codeBinding | |
| orderedBy | 0..1 | CodeableConceptBinding | |
| entry | C | 0..0 | Reference(Resource) |
| emptyReason | C | 0..1 | CodeableConceptBinding |
| section | C | 0..0 | see (section) |
| attachment | C | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| section-note | C | 0..* | Extension(Annotation) |
| modifierExtension | Σ ?! C | 0..* | Extension |
| title | 1..1 | string | |
| code | 1..1 | CodeableConceptPattern | |
| author | C | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| focus | C | 0..1 | Reference(Resource) |
| text | C | 1..1 | Narrative |
| mode | 0..1 | codeBinding | |
| orderedBy | 0..1 | CodeableConceptBinding | |
| entry | C | 1..* | Reference(Binary | DocumentReference) |
| emptyReason | C | 0..1 | CodeableConceptBinding |
| section | C | 0..0 | see (section) |
| sectionUGR | C | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| section-note | C | 0..* | Extension(Annotation) |
| modifierExtension | Σ ?! C | 0..* | Extension |
| title | 1..1 | string | |
| code | 1..1 | CodeableConceptBinding | |
| author | C | 0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| focus | C | 0..1 | Reference(Resource) |
| text | C | 1..1 | Narrative |
| mode | 0..1 | codeBinding | |
| orderedBy | 0..1 | CodeableConceptBinding | |
| entry | C | 0..* | Reference(Resource) |
| emptyReason | C | 0..1 | CodeableConceptBinding |
| section | C | 0..* | see (section) |
Detailed Descriptions
| Composition | |||
| Short | Laboratory Report composition | ||
| Definition | Laboratory Report composition. A composition is 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. | ||
| Cardinality | 0..* | ||
| 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. | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.id | |||
| Short | Logical id of this artifact | ||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
| Cardinality | 0..1 | ||
| Type | id | ||
| Summary | True | ||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.meta | |||
| Short | Metadata about the resource | ||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||
| Cardinality | 0..1 | ||
| Type | Meta | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Modifier | True | ||
| Summary | True | ||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.language | |||
| Short | Language of the composition content | ||
| Definition | The base language in which the resource is written. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | A human language.
| ||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.text | |||
| Short | Narrative text | ||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||
| Cardinality | 0..1 | ||
| Type | Narrative | ||
| Alias | narrative, html, xhtml, display | ||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.contained | |||
| Short | Contained, inline Resources | ||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||
| Cardinality | 0..* | ||
| Type | Resource | ||
| Alias | inline resources, anonymous resources, contained resources | ||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||
| Mappings |
| ||
| Composition.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:version | |||
| Short | R5: An explicitly assigned identifer of a variation of the content in the Composition (new) | ||
| Definition | R5: | ||
| Cardinality | 0..1 | ||
| Type | Extension(string) | ||
| Alias | extensions, user content | ||
| Comments | Element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:version.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.extension:version.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:version.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version | ||
| Mappings |
| ||
| Composition.extension:version.value[x] | |||
| Short | An explicitly assigned identifer of a variation of the content in the Composition | ||
| Definition | An explicitly assigned identifer of a variation of the content in the Composition. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the Composition as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:informationRecipient | |||
| Short | Composition: Information recipient | ||
| Definition | This extension applies to the Composition resource and is used to represent an intended recipient of the composition. | ||
| Cardinality | 0..* | ||
| Type | Extension(Reference(CareTeam | Device | Group | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)) | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:informationRecipient.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.extension:informationRecipient.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:informationRecipient.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.eu/fhir/StructureDefinition/information-recipient | ||
| Mappings |
| ||
| Composition.extension:informationRecipient.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..1 | ||
| Type | Reference(OrganizationEuCore | PatientEuCore | PractitionerEuCore | PractitionerRoleEuCore | Device | RelatedPerson) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport | |||
| Short | Document DiagnosticReport Reference | ||
| Definition | This extension provides a reference to the DiagnosticReport instance that is associated with this Composition. | ||
| Cardinality | 0..1 | ||
| Type | Extension(Reference(DiagnosticReport)) | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.extension:diagnosticReport.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.eu/fhir/extensions/StructureDefinition/composition-diagnosticReportReference | ||
| Mappings |
| ||
| Composition.extension:diagnosticReport.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 1..1 | ||
| Type | Reference(DiagnosticReport) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport.value[x].id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.extension:diagnosticReport.value[x].extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport.value[x].reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| 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. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Added to the FHIR R4 guide to allow strictly conformance with the R4 rules for document bundle resources inclusion. Using this extension implies to accept a circular reference Composition to/from DiagnosticReport | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport.value[x].type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||
| Cardinality | 0..1 | ||
| Type | uri | ||
| Binding | Aa resource (or, for logical models, the URI of the logical model). | ||
| Summary | True | ||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport.value[x].identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport.value[x].display | |||
| Short | Text alternative for the resource | ||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Alias | extensions, user content | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.identifier | |||
| Short | Report identifier | ||
| Definition | Identifiers assigned to this document by the performer or other systems. Should remain stable across versions of the report. | ||
| Cardinality | 1..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Comments | Composition.identifier SHALL be equal to one of the DiagnosticReport.identifier, if at least one exists | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.status | |||
| Short | preliminary | final | amended | entered-in-error | ||
| Definition | Fixed value of 'final' | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The workflow/clinical status of the composition. | ||
| Modifier | True | ||
| Summary | 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 "entered-in-error" 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | final | ||
| Mappings |
| ||
| Composition.type | |||
| Short | Type of (Laboratory) Report | ||
| Definition | SNOMED CT code for either a Laboratory Report (4241000179101) or Genetic report (1054161000000101) | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Type of a composition. | ||
| Summary | True | ||
| Requirements | Key metadata element describing the composition, used in searching/filtering. | ||
| Comments | At least one DiagnosticReport.code.coding and Composition.type.coding SHALL be equal | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.category | |||
| Short | Report Category | ||
| Definition | Fixed codes for conformance to the EU Lab Composition profile (for cross border sharing of lab reports). | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | High-level kind of a clinical document at a macro level. | ||
| Summary | True | ||
| Requirements | Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. | ||
| Comments | DiagnosticReport.category and Composition.category shall be aligned | ||
| Slicing | Unordered, Open, by $this(Value) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.category:studyType | |||
| Short | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) | ||
| Definition | Laboratory services, i.e., results of tests performed, could be characterized using typology of services, commonly called study types. Study type could be seen as an attribute or grouping mechanism that assigns a common clinical sense to certain types of laboratory test results., e.g., Hemoglobin, Platelet count, etc. belongs to 'Hematology study'. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | High-level kind of a clinical document at a macro level. | ||
| Summary | True | ||
| Requirements | Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. | ||
| Comments | In comparison to the laboratory specialty which is an attribute of laboratory, study type is a categorization of laboratory service. It needs to be mentioned that classification of test to study types in not standardized. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | {
"coding": [
{
"system": "http://loinc.org",
"code": "26436-6",
"display": "Laboratory studies (set)"
}
]
} | ||
| Mappings |
| ||
| Composition.category:specialty | |||
| Short | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) | ||
| Definition | Laboratory specialty is an attribute of any laboratory setting representing professional qualification of the laboratory to execute certain kind of laboratory tests. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | High-level kind of a clinical document at a macro level. | ||
| Summary | True | ||
| Requirements | Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. | ||
| Comments | Specialty could be used as parameter for searching/querying of laboratory test results. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1236877003",
"display": "Genetic pathology"
}
]
} | ||
| Mappings |
| ||
| Composition.subject | |||
| Short | Who and/or what the composition is about | ||
| Definition | Matches subject reference included in either the DiagnosticReport or ServiceRequest | ||
| Cardinality | 1..1 | ||
| Type | Reference(LocationEuCore | PatientEuCore | Device | Group) | ||
| Summary | True | ||
| Requirements | Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about. | ||
| Comments | DiagnosticReport and Composition SHALL have the same subject | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.encounter | |||
| Short | The healthcare event which this Laboratory Report is about (when test ordered). | ||
| Definition | The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Encounter) | ||
| Summary | True | ||
| Requirements | Provides context for the composition and supports searching. | ||
| Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). DiagnosticReport and Composition SHALL have the same encounter. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.date | |||
| Short | Composition editing time | ||
| Definition | SHALL be the dateTime the Composition was generated by the central broker | ||
| Cardinality | 1..1 | ||
| Type | dateTime | ||
| Summary | True | ||
| Requirements | dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring. When packaged in a document, Bundle.timestamp is the date of packaging. | ||
| Comments | The Last Modified Date on the composition may be after the date of the document was attested without being changed. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.author | |||
| Short | Who and/or what authored the composition | ||
| Definition | Fixed to an identifier for the central broker (TBC). The author for the underlying ServiceRequest or DiagnosticReport can be retrieved by interrogating the appropriate resources. | ||
| Cardinality | 1..* | ||
| Type | Reference(OrganizationEuCore | PatientEuCore | PractitionerEuCore | PractitionerRoleEuCore | Device | RelatedPerson) | ||
| Summary | True | ||
| Requirements | Identifies who is responsible for the content. | ||
| Comments | If a DiagnosticReport.resultsInterpreter exists this is expected to be a Composition.author; otherwise a DiagnosticReport.performer should be an author. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.title | |||
| Short | Laboratory Report | ||
| Definition | SHALL match the SNOMED CT display used within Composition.type | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | Genetic report | ||
| Mappings |
| ||
| Composition.confidentiality | |||
| Short | As defined by affinity domain | ||
| Definition | The code specifying the level of confidentiality of the Composition. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | Codes specifying the level of confidentiality of the composition. | ||
| Summary | 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). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester | |||
| Short | Attests the report accuracy | ||
| Definition | A participant who has attested to the accuracy of the composition/document. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Requirements | Identifies responsibility for the accuracy of the composition content. | ||
| Comments | Only list each attester once. | ||
| Slicing | Unordered, Open, by mode(Value) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.attester.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester.mode | |||
| Short | The type of attestation | ||
| Definition | The type of attestation the authenticator offers. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The way in which a person authenticated a composition. | ||
| Requirements | Indicates the level of authority of the attestation. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester.time | |||
| Short | When the report was attested by the party | ||
| Definition | When the composition was attested by the party. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | ||
| Requirements | Identifies when the information in the composition was deemed accurate. (Things may have changed since then.). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester.party | |||
| Short | Who attested the report | ||
| Definition | Who attested the composition in the specified way. | ||
| Cardinality | 0..1 | ||
| Type | Reference(OrganizationEuCore | PatientEuCore | PractitionerEuCore | PractitionerRoleEuCore | RelatedPerson) | ||
| Requirements | Identifies who has taken on the responsibility for accuracy of the composition content. | ||
| Comments | For a Laboratory Report it is usually non expected that the attester would be a Patient or a RealtedPerson | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester:legalAuthenticator | |||
| Short | Attests to accuracy of composition | ||
| Definition | A participant who has attested to the accuracy of the composition/document. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Requirements | Identifies responsibility for the accuracy of the composition content. | ||
| Comments | Only list each attester once. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester:legalAuthenticator.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.attester:legalAuthenticator.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester:legalAuthenticator.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester:legalAuthenticator.mode | |||
| Short | personal | professional | legal | official | ||
| Definition | The type of attestation the authenticator offers. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The way in which a person authenticated a composition. | ||
| Requirements | Indicates the level of authority of the attestation. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | legal | ||
| Mappings |
| ||
| Composition.attester:legalAuthenticator.time | |||
| Short | When the composition was attested | ||
| Definition | When the composition was attested by the party. | ||
| Cardinality | 1..1 | ||
| Type | dateTime | ||
| Requirements | Identifies when the information in the composition was deemed accurate. (Things may have changed since then.). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester:legalAuthenticator.party | |||
| Short | Who attested the composition | ||
| Definition | Who attested the composition in the specified way. | ||
| Cardinality | 1..1 | ||
| Type | Reference(PractitionerEuCore | PractitionerRoleEuCore) | ||
| Requirements | Identifies who has taken on the responsibility for accuracy of the composition content. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester:validator | |||
| Short | Attests to accuracy of composition | ||
| Definition | A participant who has attested to the accuracy of the composition/document. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Requirements | Identifies responsibility for the accuracy of the composition content. | ||
| Comments | Only list each attester once. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester:validator.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.attester:validator.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester:validator.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester:validator.mode | |||
| Short | personal | professional | legal | official | ||
| Definition | The type of attestation the authenticator offers. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The way in which a person authenticated a composition. | ||
| Requirements | Indicates the level of authority of the attestation. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | professional | ||
| Mappings |
| ||
| Composition.attester:validator.time | |||
| Short | When the composition was attested | ||
| Definition | When the composition was attested by the party. | ||
| Cardinality | 1..1 | ||
| Type | dateTime | ||
| Requirements | Identifies when the information in the composition was deemed accurate. (Things may have changed since then.). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester:validator.party | |||
| Short | Who attested the composition | ||
| Definition | Who attested the composition in the specified way. | ||
| Cardinality | 1..1 | ||
| Type | Reference(PractitionerEuCore | PractitionerRoleEuCore) | ||
| Requirements | Identifies who has taken on the responsibility for accuracy of the composition content. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.custodian | |||
| Short | Organization which maintains the composition | ||
| Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. | ||
| Cardinality | 0..1 | ||
| Type | Reference(OrganizationEuCore) | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.relatesTo | |||
| Short | Relationships to other compositions/documents | ||
| Definition | Relationships that this composition has with other compositions or documents that already exist. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Comments | A document is a version specific composition. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.relatesTo.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.relatesTo.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.relatesTo.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.relatesTo.code | |||
| Short | replaces | transforms | signs | appends | ||
| Definition | The type of relationship that this composition has with anther composition or document. | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Binding | The type of relationship between documents. | ||
| Comments | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.relatesTo.target[x] | |||
| Short | Target of the relationship | ||
| Definition | The target composition/document of this relationship. | ||
| Cardinality | 1..1 | ||
| Type | Identifier | Reference(Composition) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.event | |||
| Short | The laboratory service(s) being documented | ||
| Definition | The clinical service, such as a colonoscopy or an appendectomy, being documented. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Summary | True | ||
| Requirements | Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event. | ||
| Comments | The event needs to be consistent with the type element, though can provide further information if desired. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.event.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.event.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.event.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.event.code | |||
| Short | Code(s) that apply to the laboratory service(s) being documented | ||
| Definition | This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | This list of codes represents the main clinical acts being documented. | ||
| Summary | True | ||
| Comments | An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.event.period | |||
| Short | Period of time covered by the documentation | ||
| Definition | The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.event.detail | |||
| Short | The laboratory service(s) being documented | ||
| Definition | The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy. | ||
| Cardinality | 0..* | ||
| Type | Reference(Resource) | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section | |||
| Short | Composition is broken into sections | ||
| Definition | To conform to EU Lab, SHOULD include references to the results that form part of the genomic report. For the UGR, will include sections that conform to the UGR folders, this work is currently in development. | ||
| Cardinality | 1..* | ||
| Type | BackboneElement | ||
| Slicing | Unordered, Open, by $this.code(Pattern) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.section.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.extension:section-note | |||
| Short | Additional notes that apply to the section (but not to specific resource). | ||
| Definition | Additional notes that apply to the section (but not to specific resource). | ||
| Cardinality | 0..* | ||
| Type | Extension(Annotation) | ||
| Alias | extensions, user content | ||
| Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.title | |||
| Short | Label for section (e.g. for ToC) | ||
| Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Alias | header, label, caption | ||
| Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. | ||
| Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.code | |||
| Short | Classification of section (recommended) | ||
| Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Classification of a section of a composition/document. | ||
| Requirements | Provides computable standardized labels to topics within the document. | ||
| Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.author | |||
| Short | Who and/or what authored the section | ||
| Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. | ||
| Cardinality | 0..* | ||
| Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| Requirements | Identifies who is responsible for the content. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.focus | |||
| Short | Who/what the section is about, when it is not about the subject of composition | ||
| Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). | ||
| Cardinality | 0..1 | ||
| Type | Reference(Resource) | ||
| Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.text | |||
| Short | Text summary of the section, for human interpretation | ||
| Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. | ||
| Cardinality | 1..1 | ||
| Type | Narrative | ||
| Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.mode | |||
| Short | working | snapshot | changes | ||
| Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | The processing mode that applies to this section. | ||
| Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. | ||
| Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.orderedBy | |||
| Short | Order of section entries | ||
| Definition | Specifies the order applied to the items in the section entries. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | What order applies to the items in the entry. | ||
| Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. | ||
| Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.entry | |||
| Short | A reference to data that supports this section | ||
| Definition | A reference to the actual resource from which the narrative in the section is derived. | ||
| Cardinality | 0..* | ||
| Type | Reference(Resource) | ||
| Comments | If there are no entries in the list, an emptyReason SHOULD be provided. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.emptyReason | |||
| Short | Empty reason | ||
| Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | If a section is empty, why it is empty. | ||
| Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. | ||
| Comments | The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.section | |||
| Short | Nested Section | ||
| Definition | A nested sub-section within this section. | ||
| Cardinality | 0..* | ||
| Type | see (section) | ||
| Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: cmp-1 | ||
| Mappings |
| ||
| Composition.section:annotations | |||
| Short | Annotation comment | ||
| Definition | Narrative expression of comments accompanying the report, such as suggestions for evaluation, technical notes from the laboratory, etc. Examples: Suggestion: This result should be evaluated in relation to the patient's medical history and clinical condition. Technical note: A list of accredited examination(s) is available at www.laboratory.com. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.section:annotations.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.extension:section-note | |||
| Short | Additional notes that apply to the section (but not to specific resource). | ||
| Definition | Additional notes that apply to the section (but not to specific resource). | ||
| Cardinality | 0..* | ||
| Type | Extension(Annotation) | ||
| Alias | extensions, user content | ||
| Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.title | |||
| Short | Label for section (e.g. for ToC) | ||
| Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Alias | header, label, caption | ||
| Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. | ||
| Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.code | |||
| Short | Classification of section (recommended) | ||
| Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Classification of a section of a composition/document. | ||
| Requirements | Provides computable standardized labels to topics within the document. | ||
| Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | {
"coding": [
{
"system": "http://loinc.org",
"code": "48767-8"
}
]
} | ||
| Mappings |
| ||
| Composition.section:annotations.author | |||
| Short | Who and/or what authored the section | ||
| Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. | ||
| Cardinality | 0..* | ||
| Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| Requirements | Identifies who is responsible for the content. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.focus | |||
| Short | Who/what the section is about, when it is not about the subject of composition | ||
| Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). | ||
| Cardinality | 0..1 | ||
| Type | Reference(Resource) | ||
| Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.text | |||
| Short | Text summary of the section, for human interpretation | ||
| Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. | ||
| Cardinality | 1..1 | ||
| Type | Narrative | ||
| Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.mode | |||
| Short | working | snapshot | changes | ||
| Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | The processing mode that applies to this section. | ||
| Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. | ||
| Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.orderedBy | |||
| Short | Order of section entries | ||
| Definition | Specifies the order applied to the items in the section entries. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | What order applies to the items in the entry. | ||
| Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. | ||
| Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.entry | |||
| Short | A reference to data that supports this section | ||
| Definition | A reference to the actual resource from which the narrative in the section is derived. | ||
| Cardinality | 0..0 | ||
| Type | Reference(Resource) | ||
| Comments | If there are no entries in the list, an emptyReason SHOULD be provided. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.emptyReason | |||
| Short | Empty reason | ||
| Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | If a section is empty, why it is empty. | ||
| Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. | ||
| Comments | The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.section | |||
| Short | Nested Section | ||
| Definition | A nested sub-section within this section. | ||
| Cardinality | 0..0 | ||
| Type | see (section) | ||
| Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: cmp-1 | ||
| Mappings |
| ||
| Composition.section:attachment | |||
| Short | Additional data (like images, diagrams) associated with this report | ||
| Definition | A list of additional data associated with this report. This data is generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:attachment.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.section:attachment.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:attachment.extension:section-note | |||
| Short | Additional notes that apply to the section (but not to specific resource). | ||
| Definition | Additional notes that apply to the section (but not to specific resource). | ||
| Cardinality | 0..* | ||
| Type | Extension(Annotation) | ||
| Alias | extensions, user content | ||
| Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:attachment.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:attachment.title | |||
| Short | Label for section (e.g. for ToC) | ||
| Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Alias | header, label, caption | ||
| Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. | ||
| Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:attachment.code | |||
| Short | Classification of section (recommended) | ||
| Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Classification of a section of a composition/document. | ||
| Requirements | Provides computable standardized labels to topics within the document. | ||
| Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | {
"coding": [
{
"system": "http://loinc.org",
"code": "77599-9"
}
]
} | ||
| Mappings |
| ||
| Composition.section:attachment.author | |||
| Short | Who and/or what authored the section | ||
| Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. | ||
| Cardinality | 0..* | ||
| Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| Requirements | Identifies who is responsible for the content. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:attachment.focus | |||
| Short | Who/what the section is about, when it is not about the subject of composition | ||
| Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). | ||
| Cardinality | 0..1 | ||
| Type | Reference(Resource) | ||
| Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:attachment.text | |||
| Short | Text summary of the section, for human interpretation | ||
| Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. | ||
| Cardinality | 1..1 | ||
| Type | Narrative | ||
| Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:attachment.mode | |||
| Short | working | snapshot | changes | ||
| Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | The processing mode that applies to this section. | ||
| Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. | ||
| Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:attachment.orderedBy | |||
| Short | Order of section entries | ||
| Definition | Specifies the order applied to the items in the section entries. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | What order applies to the items in the entry. | ||
| Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. | ||
| Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:attachment.entry | |||
| Short | A reference to data that supports this section | ||
| Definition | A reference to the actual resource from which the narrative in the section is derived. | ||
| Cardinality | 1..* | ||
| Type | Reference(Binary | DocumentReference) | ||
| Comments | If there are no entries in the list, an emptyReason SHOULD be provided. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:attachment.emptyReason | |||
| Short | Empty reason | ||
| Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | If a section is empty, why it is empty. | ||
| Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. | ||
| Comments | The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:attachment.section | |||
| Short | Nested Section | ||
| Definition | A nested sub-section within this section. | ||
| Cardinality | 0..0 | ||
| Type | see (section) | ||
| Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: cmp-1 | ||
| Mappings |
| ||
| Composition.section:sectionUGR | |||
| Short | Composition is broken into sections | ||
| Definition | Sections included within the UGR: patient-demographics | investigations-and-procedures-requested | investigation-results | consent-for-information-sharing | family-history. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:sectionUGR.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.section:sectionUGR.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:sectionUGR.extension:section-note | |||
| Short | Additional notes that apply to the section (but not to specific resource). | ||
| Definition | Additional notes that apply to the section (but not to specific resource). | ||
| Cardinality | 0..* | ||
| Type | Extension(Annotation) | ||
| Alias | extensions, user content | ||
| Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:sectionUGR.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Modifier | True | ||
| Summary | True | ||
| Alias | extensions, user content, modifiers | ||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:sectionUGR.title | |||
| Short | Label for section (e.g. for ToC) | ||
| Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Alias | header, label, caption | ||
| Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. | ||
| Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:sectionUGR.code | |||
| Short | Classification of section (recommended) | ||
| Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | UK Core Composition Section Codes | ||
| Requirements | Provides computable standardized labels to topics within the document. | ||
| Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:sectionUGR.author | |||
| Short | Who and/or what authored the section | ||
| Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. | ||
| Cardinality | 0..* | ||
| Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| Requirements | Identifies who is responsible for the content. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:sectionUGR.focus | |||
| Short | Who/what the section is about, when it is not about the subject of composition | ||
| Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). | ||
| Cardinality | 0..1 | ||
| Type | Reference(Resource) | ||
| Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:sectionUGR.text | |||
| Short | Text summary of the section, for human interpretation | ||
| Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. | ||
| Cardinality | 1..1 | ||
| Type | Narrative | ||
| Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:sectionUGR.mode | |||
| Short | working | snapshot | changes | ||
| Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. | ||
| Cardinality | 0..1 | ||
| Type | code | ||
| Binding | The processing mode that applies to this section. | ||
| Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. | ||
| Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:sectionUGR.orderedBy | |||
| Short | Order of section entries | ||
| Definition | Specifies the order applied to the items in the section entries. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | What order applies to the items in the entry. | ||
| Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. | ||
| Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:sectionUGR.entry | |||
| Short | A reference to data that supports this section | ||
| Definition | A reference to the actual resource from which the narrative in the section is derived. | ||
| Cardinality | 0..* | ||
| Type | Reference(Resource) | ||
| Comments | If there are no entries in the list, an emptyReason SHOULD be provided. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:sectionUGR.emptyReason | |||
| Short | Empty reason | ||
| Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | If a section is empty, why it is empty. | ||
| Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. | ||
| Comments | The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:sectionUGR.section | |||
| Short | Nested Section | ||
| Definition | A nested sub-section within this section. | ||
| Cardinality | 0..* | ||
| Type | see (section) | ||
| Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: cmp-1 | ||
| Mappings |
| ||
Table View
| Composition | 0..* | |
| Composition.id | id | 0..1 |
| Composition.meta | Meta | 0..1 |
| Composition.implicitRules | uri | 0..1 |
| Composition.language | code | 0..1 |
| Composition.text | Narrative | 0..1 |
| Composition.contained | Resource | 0..* |
| Composition.extension | Extension | 1..* |
| Composition.extension:versionNumber | Extension | 0..1 |
| Composition.extension:information-recipient | Extension | 0..* |
| Composition.extension:information-recipient.id | string | 0..1 |
| Composition.extension:information-recipient.extension | Extension | 0..0 |
| Composition.extension:information-recipient.url | uri | 1..1 |
| Composition.extension:information-recipient.value[x] | Reference(PatientEuCore | PractitionerEuCore | PractitionerRoleEuCore | Device | Organization | RelatedPerson) | 0..1 |
| Composition.extension:diagnosticReport-reference | Extension | 1..1 |
| Composition.extension:diagnosticReport-reference.id | string | 0..1 |
| Composition.extension:diagnosticReport-reference.extension | Extension | 0..0 |
| Composition.extension:diagnosticReport-reference.url | uri | 1..1 |
| Composition.extension:diagnosticReport-reference.value[x] | Reference(DiagnosticReportLabEu) | 0..1 |
| Composition.extension:diagnosticReport-reference.value[x].id | string | 0..1 |
| Composition.extension:diagnosticReport-reference.value[x].extension | Extension | 0..* |
| Composition.extension:diagnosticReport-reference.value[x].reference | string | 1..1 |
| Composition.extension:diagnosticReport-reference.value[x].type | uri | 0..1 |
| Composition.extension:diagnosticReport-reference.value[x].identifier | Identifier | 0..1 |
| Composition.extension:diagnosticReport-reference.value[x].display | string | 0..1 |
| Composition.modifierExtension | Extension | 0..* |
| Composition.identifier | Identifier | 0..1 |
| Composition.status | code | 1..1 |
| Composition.type | CodeableConceptIPS | 1..1 |
| Composition.category | CodeableConceptIPS | 0..* |
| Composition.category:studyType | CodeableConcept | 0..* |
| Composition.category:specialty | CodeableConcept | 0..* |
| Composition.subject | Reference(PatientEuCore | PatientAnimalEu | Device | Group | Location) | 1..1 |
| Composition.encounter | Reference(Encounter) | 0..1 |
| Composition.date | dateTime | 1..1 |
| Composition.author | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 1..* |
| Composition.title | string | 1..1 |
| Composition.confidentiality | code | 0..1 |
| Composition.attester | BackboneElement | 0..* |
| Composition.attester.id | string | 0..1 |
| Composition.attester.extension | Extension | 0..* |
| Composition.attester.modifierExtension | Extension | 0..* |
| Composition.attester.mode | code | 1..1 |
| Composition.attester.time | dateTime | 0..1 |
| Composition.attester.party | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 0..1 |
| Composition.custodian | Reference(Organization) | 0..1 |
| Composition.relatesTo | BackboneElement | 0..* |
| Composition.relatesTo.id | string | 0..1 |
| Composition.relatesTo.extension | Extension | 0..* |
| Composition.relatesTo.modifierExtension | Extension | 0..* |
| Composition.relatesTo.code | code | 1..1 |
| Composition.relatesTo.target[x] | Identifier | Reference(Composition) | 1..1 |
| Composition.event | BackboneElement | 0..* |
| Composition.event.id | string | 0..1 |
| Composition.event.extension | Extension | 0..* |
| Composition.event.modifierExtension | Extension | 0..* |
| Composition.event.code | CodeableConcept | 0..* |
| Composition.event.period | Period | 0..1 |
| Composition.event.detail | Reference(Resource) | 0..* |
| Composition.section | BackboneElement | 1..* |
| Composition.section.id | string | 0..1 |
| Composition.section.extension | Extension | 0..* |
| Composition.section.modifierExtension | Extension | 0..* |
| Composition.section.title | string | 1..1 |
| Composition.section.code | CodeableConceptIPS | 1..1 |
| Composition.section.author | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 0..* |
| Composition.section.focus | Reference(Resource) | 0..1 |
| Composition.section.text | Narrative | 0..1 |
| Composition.section.mode | code | 0..1 |
| Composition.section.orderedBy | CodeableConcept | 0..1 |
| Composition.section.entry | Reference(Resource) | 0..* |
| Composition.section.emptyReason | CodeableConcept | 0..1 |
| Composition.section.section | 0..* | |
| Composition.section:lab-no-subsections | BackboneElement | 0..* |
| Composition.section:lab-no-subsections.id | string | 0..1 |
| Composition.section:lab-no-subsections.extension | Extension | 0..* |
| Composition.section:lab-no-subsections.modifierExtension | Extension | 0..* |
| Composition.section:lab-no-subsections.title | string | 0..1 |
| Composition.section:lab-no-subsections.code | CodeableConcept | 0..1 |
| Composition.section:lab-no-subsections.author | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 0..* |
| Composition.section:lab-no-subsections.focus | Reference(Resource) | 0..1 |
| Composition.section:lab-no-subsections.text | Narrative | 0..1 |
| Composition.section:lab-no-subsections.mode | code | 0..1 |
| Composition.section:lab-no-subsections.orderedBy | CodeableConcept | 0..1 |
| Composition.section:lab-no-subsections.entry | Reference(ObservationResultsLaboratoryEu) | 1..* |
| Composition.section:lab-no-subsections.emptyReason | CodeableConcept | 0..1 |
| Composition.section:lab-no-subsections.section | 0..0 | |
| Composition.section:lab-subsections | BackboneElement | 0..* |
| Composition.section:lab-subsections.id | string | 0..1 |
| Composition.section:lab-subsections.extension | Extension | 0..* |
| Composition.section:lab-subsections.modifierExtension | Extension | 0..* |
| Composition.section:lab-subsections.title | string | 0..1 |
| Composition.section:lab-subsections.code | CodeableConcept | 0..1 |
| Composition.section:lab-subsections.author | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 0..* |
| Composition.section:lab-subsections.focus | Reference(Resource) | 0..1 |
| Composition.section:lab-subsections.text | Narrative | 0..0 |
| Composition.section:lab-subsections.mode | code | 0..1 |
| Composition.section:lab-subsections.orderedBy | CodeableConcept | 0..1 |
| Composition.section:lab-subsections.entry | Reference(Resource) | 0..0 |
| Composition.section:lab-subsections.emptyReason | CodeableConcept | 0..1 |
| Composition.section:lab-subsections.section | BackboneElement | 1..* |
| Composition.section:lab-subsections.section.id | string | 0..1 |
| Composition.section:lab-subsections.section.extension | Extension | 0..* |
| Composition.section:lab-subsections.section.modifierExtension | Extension | 0..* |
| Composition.section:lab-subsections.section.title | string | 1..1 |
| Composition.section:lab-subsections.section.code | CodeableConceptIPS | 1..1 |
| Composition.section:lab-subsections.section.author | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 0..* |
| Composition.section:lab-subsections.section.focus | Reference(Resource) | 0..1 |
| Composition.section:lab-subsections.section.text | Narrative | 0..1 |
| Composition.section:lab-subsections.section.mode | code | 0..1 |
| Composition.section:lab-subsections.section.orderedBy | CodeableConcept | 0..1 |
| Composition.section:lab-subsections.section.entry | Reference(ObservationResultsLaboratoryEu) | 1..* |
| Composition.section:lab-subsections.section.emptyReason | CodeableConcept | 0..1 |
| Composition.section:lab-subsections.section.section | 0..0 | |
| Composition.section:annotations | BackboneElement | 0..* |
| Composition.section:annotations.id | string | 0..1 |
| Composition.section:annotations.extension | Extension | 0..* |
| Composition.section:annotations.modifierExtension | Extension | 0..* |
| Composition.section:annotations.title | string | 0..1 |
| Composition.section:annotations.code | CodeableConcept | 0..1 |
| Composition.section:annotations.author | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 0..* |
| Composition.section:annotations.focus | Reference(Resource) | 0..1 |
| Composition.section:annotations.text | Narrative | 1..1 |
| Composition.section:annotations.mode | code | 0..1 |
| Composition.section:annotations.orderedBy | CodeableConcept | 0..1 |
| Composition.section:annotations.entry | Reference(Resource) | 0..0 |
| Composition.section:annotations.emptyReason | CodeableConcept | 0..1 |
| Composition.section:annotations.section | 0..0 | |
| Composition.section:sectionUGR | BackboneElement | 0..* |
| Composition.section:sectionUGR.id | string | 0..1 |
| Composition.section:sectionUGR.extension | Extension | 0..* |
| Composition.section:sectionUGR.modifierExtension | Extension | 0..* |
| Composition.section:sectionUGR.title | string | 1..1 |
| Composition.section:sectionUGR.code | CodeableConceptIPS | 1..1 |
| Composition.section:sectionUGR.author | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 0..* |
| Composition.section:sectionUGR.focus | Reference(Resource) | 0..1 |
| Composition.section:sectionUGR.text | Narrative | 0..1 |
| Composition.section:sectionUGR.mode | code | 0..1 |
| Composition.section:sectionUGR.orderedBy | CodeableConcept | 0..1 |
| Composition.section:sectionUGR.entry | Reference(Resource) | 0..* |
| Composition.section:sectionUGR.emptyReason | CodeableConcept | 0..1 |
| Composition.section:sectionUGR.section | 0..* |
XML View
JSON View
| FHIR | MDS | HL7v2 |
|---|---|---|
Additional Guidance
- extension:information-recipient
- extension:diagnosticReport
- status
- type
- category
- subject
- date
- author
- title
- section
extension:information-recipient
TBC. Only relevant for EU Lab aligned reports (included in HL7 EU Laboratory Report: Composition Profile). A reference to the recipient for a report, could potentially be used to reference additional recipients over the subject and original requester for the request."extension": [ { "url": "http://hl7.eu/fhir/StructureDefinition/information-recipient", "valueReference": { "reference": "PractitionerRole/PractitionerRole-EugeneSmith-Example" } } ],
extension:diagnosticReport
TBC. Only relevant for EU Lab aligned reports (included in HL7 EU Laboratory Report: Composition Profile). A reference to the focal DiagnosticReport this Composition is for."extension": [ { "url": "http://hl7.eu/fhir/extensions/StructureDefinition/composition-diagnosticReportReference", "valueReference": { "reference": "DiagnosticReport/DiagnosticReport-GenomicVariantAssessment-Example" } } ],
status
Fixed value of 'final'"status": "final",
type
SNOMED CT code for either a Laboratory Report (4241000179101) or Genetic report (1054161000000101)"type": { "coding": [ { "system": "http://snomed.info/sct", "code": "1054161000000101", "display": "Genetic report (record artifact)" } ] },
category
Fixed codes for conformance to the EU Lab Composition profile (for cross border sharing of lab reports)."category": [ { "coding": [ { "system": "http://loinc.org", "code": "26436-6", "display": "Laboratory studies (set)" } ] }, { "coding": [ { "system": "http://snomed.info/sct", "code": "1236877003", "display": "Genetic pathology" } ] } ],
subject
Matches subject reference included in either the DiagnosticReport or ServiceRequest"subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } },
date
SHALL be the dateTime the Composition was generated by the central broker"date": "2022-07-11T09:00:00Z",
author
Fixed to an identifier for the central broker (TBC). The author for the underlying ServiceRequest or DiagnosticReport can be retrieved by interrogating the appropriate resources."author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/spine-ASID", "value": "200000000215" } } ],
title
SHALL match the SNOMED CT display used within Composition.type"title": "Genetic report (record artifact)",
section
To conform to EU Lab, SHOULD include references to the results that form part of the genomic report. For the UGR, will include sections that conform to the UGR folders, this work is currently in development."section": [ { "title": "Results", "code": { "coding": [ { "system": "http://loinc.org", "code": "26436-6", "display": "Laboratory studies (set)" } ] }, "entry": [ { "reference": "Observation/Observation-GenomicTherapeuticImplication-Example" }, { "reference": "Observation/Observation-GenomicsVariantSLC52A2-Example" } ] } ]