CardiologyReport
| Canonical URL | https://fhir.synapxe.sg/StructureDefinition/profile-cardiologyreport |
|---|---|
| Version | 1.2.0 |
| Status | Active |
| Description | This resource represents a clinical document that summarizes the findings, interpretations, and recommendations from cardiac-related diagnostic tests or procedures. It may include results from tests such as electrocardiograms (ECG), echocardiograms, cardiac catheterization, stress tests, or Holter monitoring. The report typically contains patient information, test indications, procedure details, observations, measurements, interpretations by a cardiologist, and recommendations for further management or follow-up. |
| CardiologyReport (Composition) | C | Composition | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | C | 0..1 | Narrative |
| contained | C | 0..* | Resource |
| extension | C | 0..* | Extension |
| displayMethod | C | 0..1 | Extension(string) |
| modifierExtension | Σ ?! C | 0..* | Extension |
| url | Σ | 0..0 | uri |
| identifier | Σ C | 1..* | Identifier |
| (All Slices) | |||
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uri |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| recordID | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriPattern |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| accessionNumber | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriPattern |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| version | Σ | 0..0 | string |
| status | Σ ?! | 1..1 | codeBinding |
| type | Σ | 1..1 | CodeableConceptBinding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| coding | Σ C | 1..* | Coding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| system | Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | Σ C | 1..1 | codePattern |
| display | Σ C | 1..1 | string |
| userSelected | Σ | 0..0 | boolean |
| text | Σ | 0..0 | string |
| category | Σ | 0..0 | CodeableConcept |
| subject | Σ C | 1..1 | Reference(Patient) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 1..1 | uriBindingFixed Value |
| identifier | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| display | Σ C | 0..0 | string |
| encounter | Σ C | 1..1 | Reference(Encounter) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 1..1 | uriBindingFixed Value |
| identifier | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| display | Σ C | 0..0 | string |
| date | Σ | 1..1 | dateTime |
| useContext | Σ | 0..0 | UsageContext |
| author | Σ C | 1..* | Reference(Practitioner) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 1..1 | uriBindingFixed Value |
| identifier | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uri |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| display | Σ C | 0..0 | string |
| name | Σ | 0..0 | string |
| title | Σ | 1..1 | string |
| note | 0..1 | Annotation | |
| attester | 0..* | BackboneElement | |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| modifierExtension | Σ ?! C | 0..0 | Extension |
| mode | 1..1 | CodeableConceptBinding | |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| coding | Σ C | 1..* | Coding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| system | Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | Σ C | 1..1 | codePattern |
| display | Σ C | 1..1 | string |
| userSelected | Σ | 0..0 | boolean |
| text | Σ | 0..0 | string |
| time | 0..1 | dateTime | |
| party | C | 0..1 | Reference(Practitioner) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 1..1 | uriBindingFixed Value |
| identifier | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uri |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| display | Σ C | 0..0 | string |
| custodian | Σ C | 0..1 | Reference(Organization) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 0..0 | string |
| type | Σ | 1..1 | uriBindingFixed Value |
| identifier | Σ C | 1..1 | Identifier |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| use | Σ ?! | 0..0 | codeBinding |
| type | Σ | 0..0 | CodeableConceptBinding |
| system | Σ | 1..1 | uriFixed Value |
| value | Σ C | 1..1 | string |
| period | Σ C | 0..0 | Period |
| assigner | Σ C | 0..0 | Reference(Organization) |
| display | Σ C | 0..0 | string |
| relatesTo | 0..0 | RelatedArtifact | |
| event | Σ | 0..0 | BackboneElement |
| section | C | 1..* | BackboneElement |
| (All Slices) | |||
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| modifierExtension | Σ ?! C | 0..0 | Extension |
| title | 0..0 | string | |
| code | 1..1 | CodeableConceptBinding | |
| author | C | 0..0 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| focus | C | 0..0 | Reference(Resource) |
| text | C | 0..1 | Narrative |
| orderedBy | 0..0 | CodeableConceptBinding | |
| entry | C | 0..1 | Reference(Procedure | FileAttachment) |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| reference | Σ C | 1..1 | string |
| type | Σ | 0..0 | uriBinding |
| identifier | Σ C | 0..0 | Identifier |
| display | Σ C | 0..0 | string |
| emptyReason | C | 0..0 | CodeableConceptBinding |
| section | 0..0 | see (section) | |
| Procedures | C | 1..* | BackboneElement |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| modifierExtension | Σ ?! C | 0..0 | Extension |
| title | 0..0 | string | |
| code | 1..1 | CodeableConcept | CodeableConceptBinding | |
| id | 0..0 | string | |
| extension | C | 0..* | Extension |
| coding | Σ C | 1..* | Coding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| system | Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | Σ C | 1..1 | codePattern |
| display | Σ C | 1..1 | string |
| userSelected | Σ | 0..0 | boolean |
| text | Σ | 0..0 | string |
| author | C | 0..0 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| focus | C | 0..0 | Reference(Resource) |
| text | C | 0..0 | Narrative |
| orderedBy | 0..0 | CodeableConceptBinding | |
| entry | C | 1..1 | Reference(Procedure) | Reference(Procedure | FileAttachment) |
| emptyReason | C | 0..0 | CodeableConceptBinding |
| section | 0..0 | see (section) | |
| FileAttachments | C | 0..* | BackboneElement |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| modifierExtension | Σ ?! C | 0..0 | Extension |
| title | 0..0 | stringFixed Value | |
| code | 1..1 | CodeableConcept | CodeableConceptBinding | |
| id | 0..0 | string | |
| extension | C | 0..* | Extension |
| coding | Σ C | 1..* | Coding |
| id | 0..0 | string | |
| extension | C | 0..0 | Extension |
| system | Σ | 1..1 | uriFixed Value |
| version | Σ | 0..1 | string |
| code | Σ C | 1..1 | codePattern |
| display | Σ C | 1..1 | string |
| userSelected | Σ | 0..0 | boolean |
| text | Σ | 0..0 | string |
| author | C | 0..0 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
| focus | C | 0..0 | Reference(Resource) |
| text | C | 0..0 | Narrative |
| orderedBy | 0..0 | CodeableConceptBinding | |
| entry | C | 1..1 | Reference(FileAttachment) | Reference(Procedure | FileAttachment) |
| emptyReason | C | 0..0 | CodeableConceptBinding |
| section | 0..0 | see (section) |
| Composition | |
| Short | A set of resources composed into a single coherent clinical statement with clinical attestation |
| Definition | A set of healthcare-related information that is assembled together into a single logical package 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. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.). |
| 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 | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Constraints |
|
| Mappings |
|
| Composition.meta | |
| Short | Metadata about a resource |
| Definition | The metadata about a resource. This is content in the resource 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 |
| 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 its narrative along with other profiles, value sets, etc. |
| Constraints |
|
| Mappings |
|
| Composition.language | |
| Short | Language of the resource content |
| Definition | The base language in which the resource is written. |
| Cardinality | 0..1 |
| Type | code |
| Binding | IETF language tag for 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). |
| Constraints |
|
| Mappings |
|
| Composition.text | |
| Short | Text summary of the resource, for human interpretation |
| 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 a 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: dom-6 |
| 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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| 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. |
| Conditions | The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 |
| 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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.extension:displayMethod | |
| Short | Display Method Information |
| Definition | Extension for capturing display method information |
| Cardinality | 0..1 |
| Type | Extension(string) |
| 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. |
| 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 managable, 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 |
| Summary | 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 |
| Constraints |
|
| Mappings |
|
| Composition.url | |
| Short | Canonical identifier for this Composition, represented as a URI (globally unique) |
| Definition | An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers. |
| Cardinality | 0..0 |
| Type | uri |
| Summary | True |
| Requirements | Allows the Composition to be referenced by a single globally unique identifier. |
| Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. |
| Constraints |
|
| Mappings |
|
| Composition.identifier | |
| Short | Version-independent identifier for the Composition |
| Definition | A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time. |
| Cardinality | 1..* |
| Type | Identifier |
| Summary | True |
| Comments | Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate. |
| Slicing | Unordered, Open, by system(Value) |
| Constraints |
|
| Mappings |
|
| Composition.identifier.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.identifier.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Composition.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| Composition.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Composition.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Composition.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| Composition.identifier:recordID | |
| Short | Version-independent identifier for the Composition |
| Definition | A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Comments | Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate. |
| Constraints |
|
| Mappings |
|
| Composition.identifier:recordID.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.identifier:recordID.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.identifier:recordID.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Composition.identifier:recordID.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| Composition.identifier:recordID.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Pattern | https://fhir.synapxe.sg/NamingSystem/record-id |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Composition.identifier:recordID.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Composition.identifier:recordID.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.identifier:recordID.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| Composition.identifier:accessionNumber | |
| Short | Version-independent identifier for the Composition |
| Definition | A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Comments | Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate. |
| Constraints |
|
| Mappings |
|
| Composition.identifier:accessionNumber.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.identifier:accessionNumber.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.identifier:accessionNumber.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Composition.identifier:accessionNumber.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| Composition.identifier:accessionNumber.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Pattern | https://fhir.synapxe.sg/NamingSystem/accession-no |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Composition.identifier:accessionNumber.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Composition.identifier:accessionNumber.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.identifier:accessionNumber.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| Composition.version | |
| 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..0 |
| Type | string |
| Summary | True |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.status | |
| Short | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown |
| Definition | The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.type | |
| Short | Concept - reference to a terminology or just text |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | Type of a composition. |
| Summary | True |
| Requirements | Key metadata element describing the composition, used in searching/filtering. |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| Composition.type.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.type.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.type.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..* |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| Composition.type.coding.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.type.coding.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.type.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Fixed Value | http://loinc.org |
| Mappings |
|
| Composition.type.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| Composition.type.coding.code | |
| Short | Symbol in syntax defined by the system |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Pattern | 100580-0 |
| Mappings |
|
| Composition.type.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Composition.type.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| Composition.type.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| Composition.category | |
| Short | Categorization of Composition |
| Definition | A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type. |
| Cardinality | 0..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 | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| Composition.subject | |
| Short | A reference from one resource to another |
| Definition | A reference from one resource to another. |
| Cardinality | 1..1 |
| Type | Reference(Patient) |
| Summary | True |
| Requirements | Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about. |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (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. |
| Constraints |
|
| Mappings |
|
| Composition.subject.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.subject.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.subject.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 | 0..0 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| Composition.subject.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| 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 | 1..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 known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Fixed Value | Patient |
| Mappings |
|
| Composition.subject.identifier | |
| Short | An identifier intended for computation |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| Composition.subject.identifier.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.subject.identifier.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.subject.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Composition.subject.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| Composition.subject.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/NamingSystem/nric |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Composition.subject.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Composition.subject.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.subject.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| Composition.subject.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..0 |
| 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: ref-2 |
| Constraints |
|
| Mappings |
|
| Composition.encounter | |
| Short | A reference from one resource to another |
| Definition | A reference from one resource to another. |
| Cardinality | 1..1 |
| Type | Reference(Encounter) |
| Summary | True |
| Requirements | Provides context for the composition and supports searching. |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (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. |
| Constraints |
|
| Mappings |
|
| Composition.encounter.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.encounter.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.encounter.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 | 0..0 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| Composition.encounter.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| 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 | 1..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 known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Fixed Value | Encounter |
| Mappings |
|
| Composition.encounter.identifier | |
| Short | An identifier intended for computation |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| Composition.encounter.identifier.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.encounter.identifier.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.encounter.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Composition.encounter.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| Composition.encounter.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/NamingSystem/event-id |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Composition.encounter.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Composition.encounter.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.encounter.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| Composition.encounter.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..0 |
| 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: ref-2 |
| Constraints |
|
| Mappings |
|
| Composition.date | |
| Short | Composition editing time |
| Definition | The composition editing time, when the composition was last logically changed by the author. |
| 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 this version of the Composition. 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. This means that the date on an amended document is the date of the amendment, not the date of original authorship. |
| Constraints |
|
| Mappings |
|
| Composition.useContext | |
| Short | The context that the content is intended to support |
| Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Composition instances. |
| Cardinality | 0..0 |
| Type | UsageContext |
| Summary | True |
| Requirements | Assist in searching for appropriate content. |
| Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
| Constraints |
|
| Mappings |
|
| Composition.author | |
| Short | A reference from one resource to another |
| Definition | A reference from one resource to another. |
| Cardinality | 1..* |
| Type | Reference(Practitioner) |
| Summary | True |
| Requirements | Identifies who is responsible for the content. |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (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. |
| Constraints |
|
| Mappings |
|
| Composition.author.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.author.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.author.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 | 0..0 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| Composition.author.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| 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 | 1..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 known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Fixed Value | Practitioner |
| Mappings |
|
| Composition.author.identifier | |
| Short | An identifier intended for computation |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| Composition.author.identifier.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.author.identifier.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.author.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Composition.author.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| Composition.author.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Value alternatives |
|
| Constraints |
|
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Composition.author.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Composition.author.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.author.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| Composition.author.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..0 |
| 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: ref-2 |
| Constraints |
|
| Mappings |
|
| Composition.name | |
| Short | Name for this Composition (computer friendly) |
| Definition | A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | Support human navigation and code generation. |
| Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
| Constraints |
|
| Mappings |
|
| Composition.title | |
| Short | Human Readable name/title |
| Definition | Official human-readable label for the composition. |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.note | |
| Short | Text node with attribution |
| Definition | A text note which also contains information about who made the statement and when. |
| Cardinality | 0..1 |
| Type | Annotation |
| Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). |
| Constraints |
|
| Mappings |
|
| Composition.attester | |
| 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. |
| 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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 |
| 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 managable, 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..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. |
| Constraints |
|
| Mappings |
|
| Composition.attester.mode | |
| Short | Concept - reference to a terminology or just text |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | The way in which a person authenticated a composition. |
| Requirements | Indicates the level of authority of the attestation. |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| Composition.attester.mode.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.attester.mode.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.attester.mode.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..* |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| Composition.attester.mode.coding.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.attester.mode.coding.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.attester.mode.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Fixed Value | http://hl7.org/fhir/CodeSystem/composition-attestation-mode |
| Mappings |
|
| Composition.attester.mode.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| Composition.attester.mode.coding.code | |
| Short | Symbol in syntax defined by the system |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Pattern | official |
| Mappings |
|
| Composition.attester.mode.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Composition.attester.mode.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| Composition.attester.mode.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| Composition.attester.time | |
| Short | When the composition was attested |
| 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.). |
| Comments | UTC offset is allowed for dates and partial dates |
| Constraints |
|
| Mappings |
|
| Composition.attester.party | |
| Short | A reference from one resource to another |
| Definition | A reference from one resource to another. |
| Cardinality | 0..1 |
| Type | Reference(Practitioner) |
| 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 resolvable (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. |
| Constraints |
|
| Mappings |
|
| Composition.attester.party.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.attester.party.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.attester.party.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 | 0..0 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| Composition.attester.party.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| 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 | 1..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 known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Fixed Value | Practitioner |
| Mappings |
|
| Composition.attester.party.identifier | |
| Short | An identifier intended for computation |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| Composition.attester.party.identifier.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.attester.party.identifier.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.attester.party.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Composition.attester.party.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| Composition.attester.party.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Value alternatives |
|
| Constraints |
|
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Composition.attester.party.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Composition.attester.party.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.attester.party.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| Composition.attester.party.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..0 |
| 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: ref-2 |
| Constraints |
|
| Mappings |
|
| Composition.custodian | |
| Short | A reference from one resource to another |
| Definition | A reference from one resource to another. |
| Cardinality | 0..1 |
| Type | Reference(Organization) |
| Summary | True |
| Requirements | Identifies where to go to find the current version, where to report issues, etc. |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (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. |
| Constraints |
|
| Mappings |
|
| Composition.custodian.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.custodian.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.custodian.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 | 0..0 |
| Type | string |
| Summary | True |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| Composition.custodian.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| 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 | 1..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 known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Fixed Value | Organization |
| Mappings |
|
| Composition.custodian.identifier | |
| Short | An identifier intended for computation |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
| Cardinality | 1..1 |
| Type | Identifier |
| Summary | True |
| Comments | The rules of the identifier.type determine if a check digit is part of the ID value or sent separately, such as through the checkDigit extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| Composition.custodian.identifier.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.custodian.identifier.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.custodian.identifier.use | |
| Short | usual | official | temp | secondary | old (If known) |
| Definition | The purpose of this identifier. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Identifies the purpose for this identifier, if known . |
| Modifier | True |
| Summary | True |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Constraints |
|
| Mappings |
|
| Composition.custodian.identifier.type | |
| Short | Description of identifier |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Summary | True |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Constraints |
|
| Mappings |
|
| Composition.custodian.identifier.system | |
| Short | The namespace for the identifier value |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Constraints |
|
| Fixed Value | https://fhir.synapxe.sg/NamingSystem/hci-code |
| Examples | Generalhttp://www.acme.com/identifiers/patient |
| Mappings |
|
| Composition.custodian.identifier.value | |
| Short | The value that is unique |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ident-1 |
| Constraints |
|
| Examples | General123456 |
| Mappings |
|
| Composition.custodian.identifier.period | |
| Short | Time period when id is/was valid for use |
| Definition | Time period during which identifier is/was valid for use. |
| Cardinality | 0..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.custodian.identifier.assigner | |
| Short | Organization that issued id (may be just text) |
| Definition | Organization that issued/manages the identifier. |
| Cardinality | 0..0 |
| Type | Reference(Organization) |
| Summary | True |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Constraints |
|
| Mappings |
|
| Composition.custodian.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..0 |
| 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: ref-2 |
| 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..0 |
| Type | RelatedArtifact |
| Comments | To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a resourceReference with an identifier.
|
| 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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.relatesTo.type | |
| Short | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as |
| Definition | The type of relationship to the related artifact. |
| Cardinality | 1..1 |
| Type | code |
| Binding | The type of relationship to the related artifact. |
| Summary | True |
| Comments | The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. |
| Constraints |
|
| Pattern | documentation |
| Mappings |
|
| Composition.relatesTo.classifier | |
| Short | Additional classifiers |
| Definition | Provides additional classifiers of the related artifact. |
| Cardinality | 0..0 |
| Type | CodeableConcept |
| Binding | Additional classifiers for the related artifact. |
| Summary | True |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| Composition.relatesTo.label | |
| Short | Short label |
| Definition | A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| Composition.relatesTo.display | |
| Short | Brief description of the related artifact |
| Definition | A brief description of the document or knowledge resource being referenced, suitable for display to a consumer. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| Composition.relatesTo.citation | |
| Short | Bibliographic citation for the artifact |
| Definition | A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format. |
| Cardinality | 1..1 |
| Type | markdown |
| Summary | True |
| Comments | Additional structured information about citations should be captured as extensions. |
| Constraints |
|
| Mappings |
|
| Composition.relatesTo.document | |
| Short | Content in a format defined elsewhere |
| Definition | For referring to data content defined in other formats. |
| Cardinality | 1..1 |
| Type | Attachment |
| Summary | True |
| Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". |
| Constraints |
|
| Mappings |
|
| Composition.relatesTo.resource | |
| Short | What artifact is being referenced |
| Definition | The related artifact, such as a library, value set, profile, or other knowledge resource. |
| Cardinality | 0..0 |
| Type | canonical(Resource) |
| Summary | True |
| Comments | If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource. |
| Constraints |
|
| Mappings |
|
| Composition.relatesTo.resourceReference | |
| Short | What artifact, if not a conformance resource |
| Definition | The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource. |
| Cardinality | 0..0 |
| Type | Reference(Resource) |
| Summary | True |
| Comments | If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases. |
| Constraints |
|
| Mappings |
|
| Composition.relatesTo.publicationStatus | |
| Short | draft | active | retired | unknown |
| Definition | The publication status of the artifact being referred to. |
| Cardinality | 0..0 |
| Type | code |
| Binding | Publication status of an artifact being referred to. |
| Summary | True |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Constraints |
|
| Mappings |
|
| Composition.relatesTo.publicationDate | |
| Short | Date of publication of the artifact being referred to |
| Definition | The date of publication of the artifact being referred to. |
| Cardinality | 0..0 |
| Type | date |
| Summary | True |
| Constraints |
|
| Mappings |
|
| Composition.event | |
| Short | The clinical service(s) being documented |
| Definition | The clinical service, such as a colonoscopy or an appendectomy, being documented. |
| Cardinality | 0..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. |
| 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 |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 |
| 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 managable, 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. |
| Constraints |
|
| Mappings |
|
| Composition.event.period | |
| Short | The period 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. |
| Constraints |
|
| Mappings |
|
| Composition.event.detail | |
| Short | The event(s) being documented, as code(s), reference(s), or both |
| Definition | 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 case the procedure being documented is necessarily a "History and Physical" act. The events may be included as a code or as a reference to an other resource. |
| Cardinality | 0..* |
| Type | CodeableReference(Resource) |
| 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 events 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. |
| Constraints |
|
| Mappings |
|
| Composition.section | |
| Short | Composition is broken into sections |
| Definition | The root of the sections that make up the composition. |
| Cardinality | 1..* |
| Type | BackboneElement |
| Slicing | Unordered, Open, by code.coding.code(Value) |
| 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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| 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 managable, 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 |
| 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 managable, 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..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. |
| 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 | 0..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.section.code | |
| Short | Concept - reference to a terminology or just text |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| 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 | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| 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..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 resolvable (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. |
| 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..0 |
| 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. |
| 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 | 0..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: cmp-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..0 |
| 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. |
| 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..1 |
| Type | Reference(Procedure | FileAttachment) |
| 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: cmp-1, cmp-2 |
| Constraints |
|
| Mappings |
|
| Composition.section.entry.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.section.entry.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.section.entry.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 | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2, ref-1 |
| Constraints |
|
| Mappings |
|
| Composition.section.entry.type | |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| 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..0 |
| 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 known RESTful URL) or by resolving the target of the reference. |
| Constraints |
|
| Mappings |
|
| Composition.section.entry.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..0 |
| 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). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Conditions | The cardinality or value of this element may be affected by these constraints: ref-2 |
| Constraints |
|
| Mappings |
|
| Composition.section.entry.display | |
| Short | Text alternative for the resource |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Cardinality | 0..0 |
| 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: ref-2 |
| Constraints |
|
| Mappings |
|
| Composition.section.emptyReason | |
| Short | Why the section is empty |
| Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
| Cardinality | 0..0 |
| 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: cmp-2 |
| Constraints |
|
| Mappings |
|
| Composition.section.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. |
| Mappings |
|
| Composition.section:Procedures | |
| Short | Composition is broken into sections |
| Definition | The root of the sections that make up the composition. |
| Cardinality | 1..* |
| Type | BackboneElement |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.section:Procedures.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.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 managable, 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..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. |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.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 | 0..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.code | |
| Short | Concept - reference to a terminology or just text |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| Cardinality | 1..1 |
| Type | CodeableConcept | CodeableConcept |
| Binding | Classification of a section of a composition/document. |
| Requirements | Provides computable standardized labels to topics within the document. |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.code.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.section:Procedures.code.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.code.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..* |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.code.coding.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.section:Procedures.code.coding.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.code.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Fixed Value | http://loinc.org |
| Mappings |
|
| Composition.section:Procedures.code.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.code.coding.code | |
| Short | Symbol in syntax defined by the system |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Pattern | 29554-3 |
| Mappings |
|
| Composition.section:Procedures.code.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.code.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.code.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.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..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 resolvable (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. |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.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..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.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 | 0..0 |
| 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: cmp-1 |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.orderedBy | |
| Short | Order of section entries |
| Definition | Specifies the order applied to the items in the section entries. |
| Cardinality | 0..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.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..1 |
| Type | Reference(Procedure) | Reference(Procedure | FileAttachment) |
| 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: cmp-1, cmp-2 |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.emptyReason | |
| Short | Why the section is empty |
| Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
| Cardinality | 0..0 |
| 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: cmp-2 |
| Constraints |
|
| Mappings |
|
| Composition.section:Procedures.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. |
| Mappings |
|
| Composition.section:FileAttachments | |
| Short | Composition is broken into sections |
| Definition | The root of the sections that make up the composition. |
| Cardinality | 0..* |
| Type | BackboneElement |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.section:FileAttachments.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.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 managable, 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..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. |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.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 | 0..0 |
| 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. |
| Constraints |
|
| Fixed Value | FileAttachments |
| Mappings |
|
| Composition.section:FileAttachments.code | |
| Short | Concept - reference to a terminology or just text |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| Cardinality | 1..1 |
| Type | CodeableConcept | CodeableConcept |
| Binding | Classification of a section of a composition/document. |
| Requirements | Provides computable standardized labels to topics within the document. |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.code.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.section:FileAttachments.code.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.code.coding | |
| Short | Code defined by a terminology system |
| Definition | A reference to a code defined by a terminology system. |
| Cardinality | 1..* |
| Type | Coding |
| Summary | True |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.code.coding.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..0 |
| Type | string |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Mappings |
|
| Composition.section:FileAttachments.code.coding.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 managable, 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 |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.code.coding.system | |
| Short | Identity of the terminology system |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 1..1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Constraints |
|
| Fixed Value | http://loinc.org |
| Mappings |
|
| Composition.section:FileAttachments.code.coding.version | |
| Short | Version of the system - if relevant |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0..1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.code.coding.code | |
| Short | Symbol in syntax defined by the system |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 1..1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Pattern | 28570-0 |
| Mappings |
|
| Composition.section:FileAttachments.code.coding.display | |
| Short | Representation defined by the system |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 1..1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Comments | Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size |
| Conditions | The cardinality or value of this element may be affected by these constraints: cod-1 |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.code.coding.userSelected | |
| Short | If this coding was chosen directly by the user |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Cardinality | 0..0 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.code.text | |
| Short | Plain text representation of the concept |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Cardinality | 0..0 |
| Type | string |
| Summary | True |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.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..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 resolvable (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. |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.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..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.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 | 0..0 |
| 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: cmp-1 |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.orderedBy | |
| Short | Order of section entries |
| Definition | Specifies the order applied to the items in the section entries. |
| Cardinality | 0..0 |
| 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. |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.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..1 |
| Type | Reference(FileAttachment) | Reference(Procedure | FileAttachment) |
| 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: cmp-1, cmp-2 |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.emptyReason | |
| Short | Why the section is empty |
| Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
| Cardinality | 0..0 |
| 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: cmp-2 |
| Constraints |
|
| Mappings |
|
| Composition.section:FileAttachments.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. |
| Mappings |
|
Example
Example-BundleCardiologyReport
Business Information Model
Key Design Considerations
Composition.typewill be used to differentiate the various documents as indicated in FHIR Document Type Codes). In this case,type.coding.codeshould store100580-0.Composition.section.codewill be used to differentiate the various section types as indicated in Document Section Code Value Set29554-3for the Procedures section.28570-0for the FileAttachments section.
A procedure may contain multiple reports, medication administrations and focal devices. As such, a sequence number is tag to each
Procedure,DiagnosticReport,MedicationAdministrationandDeviceresource to track the sequential order within its respective lists. The resource'sidentifier.valuewill store this sequence number withhttps://fhir.synapxe.sg/NamingSystem/sequence-noas its name space (identifier.system).There are two categories of devices documented in the cardiology report that uses the Device resource. First category are devices used during the procedures performed on the patient which are stored in
Composition.section.entry. Second category are focal devices implanted or removed from the patient which are stored inProcedure.focalDevice.manipulated.
API Specification
See Composition.$submit and Composition.$retrieve for the API specification to submit and retrieve cardiology reports.
Terminology Bindings
| Path | Binding Strength | Value Set (Code System) | Description |
|---|---|---|---|
| Composition.language | required | http://hl7.org/fhir/ValueSet/all-languages|5.0.0 | IETF language tag for a human language |
| Composition.status | required | http://hl7.org/fhir/ValueSet/composition-status|5.0.0 | The workflow/clinical status of the composition. |
| Composition.type | preferred | http://hl7.org/fhir/ValueSet/doc-typecodes | Type of a composition. |
| Composition.subject.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| Composition.encounter.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| Composition.author.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| Composition.attester.mode | preferred | http://hl7.org/fhir/ValueSet/composition-attestation-mode | The way in which a person authenticated a composition. |
| Composition.attester.party.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| Composition.custodian.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | Aa resource (or, for logical models, the URI of the logical model). |
| Composition.relatesTo.type | required | http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0 | The type of relationship to the related artifact. |
| Composition.event.detail | example | http://terminology.hl7.org/ValueSet/v3-ActCode | This list of codes represents the main clinical acts being documented. |
| Composition.section.code | required | https://fhir.synapxe.sg/ValueSet/doc-section-code | Classification of a section of a composition/document. |
| Composition.section.code | required | https://fhir.synapxe.sg/ValueSet/doc-section-code | Classification of a section of a composition/document. |
| Composition.section.code | required | https://fhir.synapxe.sg/ValueSet/doc-section-code | Classification of a section of a composition/document. |
Constraints
XML to FHIR Mapping
| XML element | FHIR mapping |
|---|---|
content/Composition/displayMethod |
Composition.extension:displayMethod |
content/Composition/identifier |
Composition.identifier |
content/Composition/date |
Composition.date |
content/Composition/type |
Composition.type |
content/Composition/title |
Composition.title |
content/Composition/status |
Composition.status |
content/Composition/author/id |
Composition.author.identifier |
content/Composition/author/name |
Composition.author.display |
content/Composition/attester/time |
Composition.attester.time |
content/Composition/attester/party/id |
Composition.attester.party.identifier |
content/Composition/attester/party/name |
Composition.attester.party.display |
content/Composition/custodian/institution |
Composition.custodian.identifier |
content/Composition/encounter/identifier |
Composition.encounter.identifier |
content/Composition/accessionNumber |
Composition.identifier |
content/Composition/remarks |
Composition.notes.text |
content/Composition/section/entry/Procedure/sequenceNo |
Procedure.extension:sequenceNo |
content/Composition/section/entry/Procedure/status |
Procedure.status |
content/Composition/section/entry/Procedure/category |
Procedure.category |
content/Composition/section/entry/Procedure/code |
Procedure.code |
content/Composition/section/entry/Procedure/performed/performedDateTime |
Procedure.performedDateTime |
content/Composition/section/entry/Procedure/performed/performedPeriod |
Procedure.performedPeriod |
content/Composition/section/entry/Procedure/notes |
Procedure.note |
fileAttachment/sequenceNo |
Composition.relatesTo.extension:sequenceNo |
fileAttachment/attachmentCategory |
Composition.relatesTo.type |
fileAttachment/contentType/code |
Composition.relatesTo.document.contentType |
fileAttachment/language |
Composition.relatesTo.document.language |
fileAttachment/data |
Composition.relatesTo.document.data |
fileAttachment/size |
Composition.relatesTo.document.size |
fileAttachment/title |
Composition.relatesTo.document.title |
fileAttachment/comments |
Composition.relatesTo.display |