CareReport
This resource represents a clinical document that summarizes the care provided to a patient during a specific encounter, episode, or period. It typically includes information such as patient details, reason for care, assessments, interventions, treatments, outcomes, and recommendations for ongoing management or follow-up.
| profile-Composition-put-care-report (Composition) | C | Composition | There are no (further) constraints on this element Element idCompositionShort description A set of resources composed into a single coherent clinical statement with clinical attestation DefinitionA 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.). 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.
| |||
| id | Σ | 0..0 | id | There are no (further) constraints on this element Element idComposition.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idComposition.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
| ||
| implicitRules | Σ ?! | 0..0 | uri | There are no (further) constraints on this element Element idComposition.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
| ||
| language | 0..0 | codeBinding | There are no (further) constraints on this element Element idComposition.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). IETF language tag
| |||
| text | 0..0 | Narrative | There are no (further) constraints on this element Element idComposition.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |||
| contained | C | 1..* | Resource | Element idComposition.containedShort description Information about an individual or animal receiving health care services Alternate namesinline resources, anonymous resources, contained resources, Vital Signs, Measurement, Results, Tests, SubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services. Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. Unordered, Closed, by $this(Type) Constraints
| ||
| Patient | C | 1..1 | profile-Composition-put-care-report-patient | Element idComposition.contained:PatientShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources, SubjectOfCare Client Resident DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. 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. profile-Composition-put-care-report-patient Constraints
| ||
| Observation | C | 1..* | profile-Composition-put-care-report-observation | Element idComposition.contained:ObservationShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources, Vital Signs, Measurement, Results, Tests DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. 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. profile-Composition-put-care-report-observation Constraints
| ||
| extension | C | 1..1 | Extension | Element idComposition.extensionShort description NA Alternate namesextensions, user content DefinitionNA NA Unordered, Closed, by Constraints
| ||
| extensionCompositionCareReportYear | C | 1..1 | Extension(string) | Element idComposition.extension:extensionCompositionCareReportYearShort description The calendar year of the care report data, such as 2023,2024,etc. Alternate namesextensions, user content DefinitionNA NA http://ihis.sg/extension/care-report-year ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idComposition.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. 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.
| ||
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idComposition.identifierShort description Version-independent identifier for the Composition DefinitionA version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time. Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.
| ||
| status | Σ ?! | 1..1 | codeBindingFixed Value | Element idComposition.statusShort description The workflw/clinical status of this composition. The status is a marker for clinical standing of the document DefinitionNA NA NA The workflow/clinical status of the composition.
finalExamples Sample Value finalMappings
| ||
| type | Σ | 1..1 | CodeableConceptBinding | Element idComposition.typeShort description Kind of composition (LOINC if possible) DefinitionNA NA NA Type of a composition. http://ihis.sg/ValueSet/hsg-document-type (required) Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idComposition.type.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idComposition.type.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| coding | Σ | 1..* | Coding | There are no (further) constraints on this element Element idComposition.type.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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.
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idComposition.type.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idComposition.type.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| system | Σ | 1..1 | uri | Element idComposition.type.coding.systemShort description Identity of the terminology system DefinitionNA NA NA
Fixed Value https://ihis.sg/ValueSet/hsg-document-typeMappings
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idComposition.type.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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.
| ||
| code | Σ | 1..1 | codeFixed Value | Element idComposition.type.coding.codeShort description Symbol in syntax defined by the system DefinitionNA Need to refer to a particular code in the system.
care-reportExamples Fixed Value care-reportMappings
| ||
| display | Σ | 0..1 | string | Element idComposition.type.coding.displayShort description Representation defined by the system DefinitionNA Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Fixed Value Care ReportMappings
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idComposition.type.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idComposition.type.textShort description Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
| ||
| category | Σ | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idComposition.categoryShort description Categorization of Composition DefinitionA 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. Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. This is a metadata field from XDS/MHD. High-level kind of a clinical document at a macro level. http://terminology.hl7.org/ValueSet/v3-LoincDocumentOntologyInternational (example) Constraints
| ||
| subject | Σ | 1..1 | Reference(profile-Composition-put-care-report-patient) | Element idComposition.subjectShort description Reference to the patient in patient master to link this care report data DefinitionNA Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about. For clinical documents, this is usually the patient. Reference(profile-Composition-put-care-report-patient) Allowed aggregation:contained Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idComposition.subject.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idComposition.subject.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| reference | Σ C | 1..1 | string | Element idComposition.subject.referenceShort description Literal reference, relative, internal or absolute URL DefinitionNA NA The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
Sample Value #B35F55D095F64C95B6A200D44498F47DMappings
| ||
| type | Σ | 0..0 | uriBinding | There are no (further) constraints on this element Element idComposition.subject.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe 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). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
| ||
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idComposition.subject.identifierShort description Logical reference, when literal reference is not known DefinitionAn 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. 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).
| ||
| display | Σ | 0..0 | string | There are no (further) constraints on this element Element idComposition.subject.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
| ||
| encounter | Σ | 0..0 | Reference(Encounter) | There are no (further) constraints on this element Element idComposition.encounterShort description Context of the Composition DefinitionDescribes the clinical encounter or type of care this documentation is associated with. Provides context for the composition and supports searching.
| ||
| date | Σ | 1..1 | dateTime | Element idComposition.dateShort description Care report submission date DefinitionNA NA NA
Sample Value 2022-01-01T17:00:00+08:00Mappings
| ||
| author | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Element idComposition.authorShort description Who submitted the care report DefinitionNA NA NA Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idComposition.author.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idComposition.author.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idComposition.author.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
| type | Σ | 0..0 | uriBinding | There are no (further) constraints on this element Element idComposition.author.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe 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). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
| ||
| identifier | Σ | 1..1 | Identifier | Element idComposition.author.identifierShort description Grouping of identifier DefinitionNA NA
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idComposition.author.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idComposition.author.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idComposition.author.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
| ||
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idComposition.author.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. Identifier Type Codes (extensible) Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idComposition.author.identifier.systemShort description The namespace for the identifier value DefinitionNA NA NA
http://ihis.sg/identifier/nricExamples General http://www.acme.com/identifiers/patientFixed Value http://ihis.sg/identifier/mcrMappings
| ||
| value | Σ C | 1..1 | string | Element idComposition.author.identifier.valueShort description The MCR number. DefinitionNA NA The cardinality or value of this element may be affected by these constraints: empty-value-validation Constraints
General 123456Sample Value M112233FMappings
| ||
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idComposition.author.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idComposition.author.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
| ||
| display | Σ | 0..1 | string | Element idComposition.author.displayShort description The name of the submitter DefinitionNA 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.
Sample Value Dr Sharon AngMappings
| ||
| title | Σ C | 1..1 | string | Element idComposition.titleShort description Human Readable name/title DefinitionNA NA The cardinality or value of this element may be affected by these constraints: empty-value-validation Constraints
Sample Value Care Report SubmissionMappings
| ||
| confidentiality | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element idComposition.confidentialityShort description As defined by affinity domain DefinitionThe code specifying the level of confidentiality of the Composition. The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not. Codes specifying the level of confidentiality of the composition. http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 (required) Constraints
| ||
| attester | 0..0 | BackboneElement | There are no (further) constraints on this element Element idComposition.attesterShort description Attests to accuracy of composition DefinitionA participant who has attested to the accuracy of the composition/document. Identifies responsibility for the accuracy of the composition content. Only list each attester once.
| |||
| custodian | Σ | 1..1 | Reference(Organization) | Element idComposition.custodianShort description The organization who submitted the care report DefinitionNA NA NA
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idComposition.custodian.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idComposition.custodian.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| reference | Σ C | 0..0 | string | There are no (further) constraints on this element Element idComposition.custodian.referenceShort description Literal reference, Relative, internal or absolute URL DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
| ||
| type | Σ | 1..1 | uriBindingFixed Value | Element idComposition.custodian.typeShort description Resurce type DefinitionNA NA
OrganizationExamples Fixed Value OrganizationMappings
| ||
| identifier | Σ | 1..1 | Identifier | Element idComposition.custodian.identifierShort description Grouping of identifier DefinitionNA NA
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idComposition.custodian.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idComposition.custodian.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idComposition.custodian.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
| ||
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idComposition.custodian.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. Identifier Type Codes (extensible) Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idComposition.custodian.identifier.systemShort description The namespace for the identifier value DefinitionNA NA NA
http://ihis.sg/identifier/mcrExamples General http://www.acme.com/identifiers/patientFixed Value http://ihis.sg/identifier/hci-codeMappings
| ||
| value | Σ C | 1..1 | string | Element idComposition.custodian.identifier.valueShort description HCI code. DefinitionNA NA The cardinality or value of this element may be affected by these constraints: empty-value-validation Constraints
General 123456Sample Value 123H04Mappings
| ||
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idComposition.custodian.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
| assigner | Σ | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idComposition.custodian.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
| ||
| display | Σ | 0..0 | string | There are no (further) constraints on this element Element idComposition.custodian.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
| ||
| relatesTo | 0..0 | BackboneElement | There are no (further) constraints on this element Element idComposition.relatesToShort description Relationships to other compositions/documents DefinitionRelationships that this composition has with other compositions or documents that already exist. A document is a version specific composition.
| |||
| event | Σ | 0..0 | BackboneElement | There are no (further) constraints on this element Element idComposition.eventShort description The clinical service(s) being documented DefinitionThe clinical service, such as a colonoscopy or an appendectomy, being documented. Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event. The event needs to be consistent with the type element, though can provide further information if desired.
| ||
| section | C | 1..* | BackboneElement | Element idComposition.sectionShort description Care report section DefinitionMust populate all sections
| ||
| id | 0..0 | string | There are no (further) constraints on this element Element idComposition.section.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idComposition.section.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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.
| ||
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idComposition.section.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. 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.
| ||
| title | 0..0 | string | There are no (further) constraints on this element Element idComposition.section.titleShort description Label for section (e.g. for ToC) Alternate namesheader, label, caption DefinitionThe 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. Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. 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.
| |||
| code | 1..1 | CodeableConcept | Element idComposition.section.codeShort description Type of section DefinitionTerminology code for representing the specific section in the care report data so that SOE systems can specify the correct value that can be understood by downstream systems such as MCDR NA NA Classification of a section of a composition/document. DocumentSectionCodes (example) Constraints
| |||
| id | 0..0 | id | There are no (further) constraints on this element Element idComposition.section.code.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idComposition.section.code.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| coding | Σ | 1..* | Coding | Element idComposition.section.code.codingShort description Code defined by a terminology system DefinitionNA NA NA
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idComposition.section.code.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idComposition.section.code.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idComposition.section.code.coding.systemShort description Identity of the terminology system DefinitionNA NA NA
http://ihis.sg/extension/enrollment-statusExamples Sample Value http://ihis.sg/ValueSet/hsg-carereport-sectionMappings
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idComposition.section.code.coding.versionShort description Version of the system - if relevant DefinitionThe 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. 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.
| ||
| code | Σ | 1..1 | code | Element idComposition.section.code.coding.codeShort description Terminology code. DefinitionRefer to the 'CareReportBusinessData'. NA NA
Sample Value section-generalMappings
| ||
| display | Σ | 0..1 | string | Element idComposition.section.code.coding.displayShort description Display name of the code. DefinitionRefer to the 'CareReportBusinessData'. NA NA
Sample Value General fields data groupMappings
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idComposition.section.code.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idComposition.section.code.textShort description Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
| ||
| author | 0..0 | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Element idComposition.section.authorShort description Who and/or what authored the section DefinitionIdentifies who is responsible for the information in this section, not necessarily who typed it in. Identifies who is responsible for the content. Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Constraints
| |||
| focus | 0..0 | Reference(Resource) | There are no (further) constraints on this element Element idComposition.section.focusShort description Who/what the section is about, when it is not about the subject of composition DefinitionThe 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). 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.
| |||
| text | C | 0..0 | Narrative | There are no (further) constraints on this element Element idComposition.section.textShort description Text summary of the section, for human interpretation DefinitionA 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. Document profiles may define what content should be represented in the narrative to ensure clinical safety. The cardinality or value of this element may be affected by these constraints: cmp-1 Constraints
| ||
| mode | 0..0 | codeBinding | There are no (further) constraints on this element Element idComposition.section.modeShort description working | snapshot | changes DefinitionHow the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. This element is labeled as a modifier because a change list must not be misunderstood as a complete list. The processing mode that applies to this section.
| |||
| orderedBy | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idComposition.section.orderedByShort description Order of section entries DefinitionSpecifies the order applied to the items in the section entries. Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. 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. What order applies to the items in the entry.
| |||
| entry | C | 1..* | Reference(Resource) | Element idComposition.section.entryShort description A reference to data that supports this section DefinitionThis represents the care report data element, msut populate all elements, regardless there is value or not. If there are no entries in the list, an emptyReason SHOULD be provided. The cardinality or value of this element may be affected by these constraints: cmp-2 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idComposition.section.entry.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idComposition.section.entry.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| reference | Σ C | 1..1 | string | Element idComposition.section.entry.referenceShort description A reference from one resource to another. Actual data element under the respective section DefinitionLocal reference to the specific contained observation resource, which contains the actual care report data. NA The cardinality or value of this element may be affected by these constraints: ref-1 Constraints
Sample Value #BFE94D3BE01E4160B1F4F6E7840B5562Mappings
| ||
| type | Σ | 0..0 | uriBinding | There are no (further) constraints on this element Element idComposition.section.entry.typeShort description Type the reference refers to (e.g. "Patient") DefinitionThe 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). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
| ||
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idComposition.section.entry.identifierShort description Logical reference, when literal reference is not known DefinitionAn 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. 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).
| ||
| display | Σ | 0..0 | string | There are no (further) constraints on this element Element idComposition.section.entry.displayShort description Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
| ||
| emptyReason | C | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idComposition.section.emptyReasonShort description Why the section is empty DefinitionIf the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. Allows capturing things like "none exist" or "not asked" which can be important for most lists. 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. If a section is empty, why it is empty. The cardinality or value of this element may be affected by these constraints: cmp-2 Constraints
| ||
| section | C | 0..0 | see (section) | There are no (further) constraints on this element Element idComposition.section.sectionShort description Nested Section DefinitionA nested sub-section within this section. Nested sections are primarily used to help human readers navigate to particular portions of the document. The cardinality or value of this element may be affected by these constraints: cmp-1 Constraints
|
Terminologies
| Path | Binding Strength | Value Set (Code System) | Description |
|---|---|---|---|
| Composition.status | required | http://hl7.org/fhir/ValueSet/composition-status|4.3.0 | The workflow/clinical status of the composition. |
| Composition.type | required | http://ihis.sg/ValueSet/hsg-document-type | Type of a composition. |
| Composition.attester.mode | required | http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.3.0 | The way in which a person authenticated a composition. |
| Composition.custodian.type | extensible | http://hl7.org/fhir/ValueSet/resource-types | |
| Composition.relatesTo.code | required | http://hl7.org/fhir/ValueSet/document-relationship-type|4.3.0 | The type of relationship between documents. |
| Composition.event.code | example | http://terminology.hl7.org/ValueSet/v3-ActCode | This list of codes represents the main clinical acts being documented. |
| Composition.section.code | example | http://hl7.org/fhir/ValueSet/doc-section-codes | Classification of a section of a composition/document. |