API Name: get-care-report
This API allows retrieve the latest or selected care report submitted for the resident.
Specification
| Endpoint | [baseurl]/Composition/$get-care-report |
|---|---|
| Protocol | HTTPS |
| HTTP Method | POST |
| HTTP Header | Content-Type: application/fhir+json |
| Pagination | No |
| Target System | Consumer / Provider Apps |
API Spec
This operation does NOT change content
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| patient-nric | 1..1 | string | Patient's NRIC'. |
| _id | 0..1 | string | Unique id of the care report. Optional for consumer app and NEHR, mandatory for provider app. |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| return | 0..1 | Composition | Return Care Report data as composition format |
Request Body
Remarks:
- (All Slices) is an automatically generated section and should be ignored. Do not pass this as an input parameter. It will also not be part of response.
| profile-Parameter-get-care-report (Parameters) | Parameters | There are no (further) constraints on this element Element idParametersShort description Operation Request or Response DefinitionThis resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it. The parameters that may be used are defined by the OperationDefinition resource.
| ||||
| id | Σ | 0..0 | id | There are no (further) constraints on this element Element idParameters.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idParameters.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..0 | uri | There are no (further) constraints on this element Element idParameters.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..0 | codeBinding | There are no (further) constraints on this element Element idParameters.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
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| parameter | Σ C | 1..2 | BackboneElement | Element idParameters.parameterShort description n/a DefinitionA parameter passed to or received from the operation. Unordered, Closed, by name(Value) Parameters that can be passed in as input. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| (All Slices) | The requirements in this element apply to all slices | |||||
| id | 0..1 | id | There are no (further) constraints on this element Element idParameters.parameter.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..* | Extension | There are no (further) constraints on this element Element idParameters.parameter.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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 1..1 | string | There are no (further) constraints on this element Element idParameters.parameter.nameShort description Name from the definition DefinitionThe name of the parameter (reference to the operation definition). Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value[x] | Σ C | 0..1 | There are no (further) constraints on this element Element idParameters.parameter.value[x]Short description If parameter is a data type DefinitionConveys the content if the parameter is a data type. The cardinality or value of this element may be affected by these constraints: ele-1, inv-1 Constraints
| |||
| valueAddress | Address | There are no (further) constraints on this element Data type | ||||
| valueAge | Age | There are no (further) constraints on this element Data type | ||||
| valueAnnotation | Annotation | There are no (further) constraints on this element Data type | ||||
| valueAttachment | Attachment | There are no (further) constraints on this element Data type | ||||
| valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type | ||||
| valueBoolean | boolean | There are no (further) constraints on this element Data type | ||||
| valueCanonical | canonical | There are no (further) constraints on this element Data type | ||||
| valueCode | code | There are no (further) constraints on this element Data type | ||||
| valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||||
| valueCoding | Coding | There are no (further) constraints on this element Data type | ||||
| valueContactDetail | ContactDetail | There are no (further) constraints on this element Data type | ||||
| valueContactPoint | ContactPoint | There are no (further) constraints on this element Data type | ||||
| valueContributor | Contributor | There are no (further) constraints on this element Data type | ||||
| valueCount | Count | There are no (further) constraints on this element Data type | ||||
| valueDataRequirement | DataRequirement | There are no (further) constraints on this element Data type | ||||
| valueDate | date | There are no (further) constraints on this element Data type | ||||
| valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||||
| valueDecimal | decimal | There are no (further) constraints on this element Data type | ||||
| valueDistance | Distance | There are no (further) constraints on this element Data type | ||||
| valueDosage | Dosage | There are no (further) constraints on this element Data type | ||||
| valueDuration | Duration | There are no (further) constraints on this element Data type | ||||
| valueExpression | Expression | There are no (further) constraints on this element Data type | ||||
| valueHumanName | HumanName | There are no (further) constraints on this element Data type | ||||
| valueId | id | There are no (further) constraints on this element Data type | ||||
| valueIdentifier | Identifier | There are no (further) constraints on this element Data type | ||||
| valueInstant | instant | There are no (further) constraints on this element Data type | ||||
| valueInteger | integer | There are no (further) constraints on this element Data type | ||||
| valueMarkdown | markdown | There are no (further) constraints on this element Data type | ||||
| valueMeta | Meta | There are no (further) constraints on this element Data type | ||||
| valueMoney | Money | There are no (further) constraints on this element Data type | ||||
| valueOid | oid | There are no (further) constraints on this element Data type | ||||
| valueParameterDefinition | ParameterDefinition | There are no (further) constraints on this element Data type | ||||
| valuePeriod | Period | There are no (further) constraints on this element Data type | ||||
| valuePositiveInt | positiveInt | There are no (further) constraints on this element Data type | ||||
| valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||||
| valueRange | Range | There are no (further) constraints on this element Data type | ||||
| valueRatio | Ratio | There are no (further) constraints on this element Data type | ||||
| valueReference | Reference | There are no (further) constraints on this element Data type | ||||
| valueRelatedArtifact | RelatedArtifact | There are no (further) constraints on this element Data type | ||||
| valueSampledData | SampledData | There are no (further) constraints on this element Data type | ||||
| valueSignature | Signature | There are no (further) constraints on this element Data type | ||||
| valueString | string | There are no (further) constraints on this element Data type | ||||
| valueTime | time | There are no (further) constraints on this element Data type | ||||
| valueTiming | Timing | There are no (further) constraints on this element Data type | ||||
| valueTriggerDefinition | TriggerDefinition | There are no (further) constraints on this element Data type | ||||
| valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data type | ||||
| valueUri | uri | There are no (further) constraints on this element Data type | ||||
| valueUrl | url | There are no (further) constraints on this element Data type | ||||
| valueUsageContext | UsageContext | There are no (further) constraints on this element Data type | ||||
| valueUuid | uuid | There are no (further) constraints on this element Data type | ||||
| resource | Σ C | 0..1 | Resource | There are no (further) constraints on this element Element idParameters.parameter.resourceShort description If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. The cardinality or value of this element may be affected by these constraints: inv-1 Mappings
| ||
| part | Σ | 0..* | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter.partShort description Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. | ||
| patient-nric | Σ C | 1..1 | BackboneElement | Element idParameters.parameter:patient-nricShort description n/a DefinitionNRIC of patient The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idParameters.parameter:patient-nric.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 idParameters.parameter:patient-nric.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 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 idParameters.parameter:patient-nric.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 1..1 | string | Element idParameters.parameter:patient-nric.nameShort description n/a DefinitionPatient NRIC Fixed Value: "patient-nric" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value[x] | Σ C | 1..1 | Element idParameters.parameter:patient-nric.value[x]Short description n/a DefinitionPatient NRIC n/a The cardinality or value of this element may be affected by these constraints: ele-1, inv-1 Constraints
| |||
| valueString | string | Data type | ||||
| resource | Σ C | 0..0 | Resource | There are no (further) constraints on this element Element idParameters.parameter:patient-nric.resourceShort description If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. The cardinality or value of this element may be affected by these constraints: inv-1 Mappings
| ||
| part | Σ | 0..0 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:patient-nric.partShort description Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. | ||
| care-report-id | Σ C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idParameters.parameter:care-report-idShort description Operation Parameter DefinitionA parameter passed to or received from the operation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idParameters.parameter:care-report-id.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 idParameters.parameter:care-report-id.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 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 idParameters.parameter:care-report-id.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 1..1 | string | Element idParameters.parameter:care-report-id.nameShort description n/a DefinitionCare report id Fixed Value: "care-report-id" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value[x] | Σ C | 1..1 | Element idParameters.parameter:care-report-id.value[x]Short description n/a Definitionn/a Sample Value: "1D39871DAD1149E38323B490237A66F6" The cardinality or value of this element may be affected by these constraints: ele-1, inv-1 Constraints
| |||
| valueString | string | Data type | ||||
| resource | Σ C | 0..0 | Resource | There are no (further) constraints on this element Element idParameters.parameter:care-report-id.resourceShort description If parameter is a whole resource DefinitionIf the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods. The cardinality or value of this element may be affected by these constraints: inv-1 Mappings
| ||
| part | Σ | 0..0 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:care-report-id.partShort description Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
Successful Response
| profile-Composition-get-care-report (Composition) | C | profile-Composition-get-base | There are no (further) constraints on this element Element idCompositionShort description n/a Definitionn/a n/a
| |||
| id | Σ | 1..1 | 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 1..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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | C | 1..* | Resource | Element idComposition.containedShort description n/a Alternate namesinline resources, anonymous resources, contained resources DefinitionGrouping of contained resource n/a Unordered, Closed, by $this(Type) Constraints
| ||
| Patient | C | 1..1 | profile-Composition-care-report-patient | Element idComposition.contained:PatientShort description n/a Alternate namesinline resources, anonymous resources, contained resources, SubjectOfCare Client Resident DefinitionNA NA profile-Composition-care-report-patient Constraints
| ||
| Observation | C | 1..* | profile-Composition-care-report-observation | Element idComposition.contained:ObservationShort description n/a Alternate namesinline resources, anonymous resources, contained resources, Vital Signs, Measurement, Results, Tests DefinitionNA NA profile-Composition-care-report-observation Constraints
| ||
| extension | C | 1..1 | Extension | Element idComposition.extensionShort description n/a Alternate namesextensions, user content Definitionn/a n/a Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| extensionCompositionCareReportYear | C | 1..1 | Extension(string) | Element idComposition.extension:extensionCompositionCareReportYearShort description n/a Alternate namesextensions, user content Definitionn/a Care report Assessment Year http://ihis.sg/extension/care-report-year ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idComposition.extension:extensionCompositionCareReportYear.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.extension:extensionCompositionCareReportYear.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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| url | C | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idComposition.extension:extensionCompositionCareReportYear.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
http://ihis.sg/extension/care-report-yearMappings
| ||
| value[x] | C | 1..1 | There are no (further) constraints on this element Element idComposition.extension:extensionCompositionCareReportYear.value[x]Short description n/a DefinitionCare report Assessment Year The calendar year of the care report data, such as 2023, 2024, etc The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| valueString | string | There are no (further) constraints on this element Data type | ||||
| 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idComposition.statusShort description n/a DefinitionThe workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. n/a Sample Value: "final" The workflow/clinical status of the composition. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idComposition.typeShort description n/a DefinitionKind of composition (LOINC if possible) n/a n/a Type of a composition. FHIRDocumentTypeCodes (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idComposition.type.codingShort description n/a DefinitionGrouping of coding n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idComposition.type.coding.systemShort description n/a DefinitionIdentity of the terminology system n/a Value: "http://ihis.sg/ValueSet/hsg-document-type" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idComposition.type.coding.codeShort description n/a DefinitionSymbol in syntax defined by the system n/a Fixed Value: "care-report" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ C | 0..1 | string | There are no (further) constraints on this element Element idComposition.type.coding.displayShort description n/a DefinitionRepresentation defined by the system n/a Fixed Value: "Care Report" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | Σ C | 1..1 | Reference(Patient) | Element idComposition.subjectShort description n/a DefinitionReference to the patient in patient master to link this care report data n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reference | Σ C | 1..1 | string | Element idComposition.subject.referenceShort description n/a DefinitionLiteral reference, relative, internal or absolute url Local reference to the contained Patient resource Sample Value: "#6288049DA16048D8A96B25CD8BB33630" The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | Σ C | 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| date | Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idComposition.dateShort description n/a DefinitionCare report submission date n/a Sample Value: "2022-09-10T12:30:02+08:00", "2022-09-10T12:30:02.358+08:00" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| author | Σ C | 1..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idComposition.authorShort description n/a DefinitionWho submitted the care report n/a n/a Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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: ele-1, 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idComposition.author.identifierShort description n/a DefinitionGrouping of identifier n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idComposition.author.identifier.systemShort description n/a DefinitionThe namespace for the identifier value n/a Fixed Value: "http://ihis.sg/identifier/mcr" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idComposition.author.identifier.valueShort description n/a DefinitionThe MCR number Sample Value: "M11223F" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ C | 0..1 | string | There are no (further) constraints on this element Element idComposition.author.displayShort description n/a DefinitionThe name of the submitter Sample Value: "Dr Sharon Ang" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| title | Σ C | 1..1 | string | There are no (further) constraints on this element Element idComposition.titleShort description n/a DefinitionHuman Readable name/title Sample Value: "Care Report Submission" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| confidentiality | Σ C | 1..1 | codeBinding | Element idComposition.confidentialityShort description n/a Definitionn/a Sample Value: "R" for restricted and "N" for normal Codes specifying the level of confidentiality of the composition. http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| custodian | Σ C | 1..1 | Reference(Organization) | There are no (further) constraints on this element Element idComposition.custodianShort description n/a DefinitionThe organziation who submitted the care report n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reference | Σ C | 1..1 | string | There are no (further) constraints on this element Element idComposition.custodian.referenceShort description n/a DefinitionResource logical ID Sample Value: "/Organization/6288049DA16048D8A96B25CD8BB33630" The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
| type | Σ C | 1..1 | uriBinding | There are no (further) constraints on this element Element idComposition.custodian.typeShort description n/a DefinitionResource type Fixed Value: "Organization" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idComposition.custodian.identifierShort description n/a DefinitionGrouping of identifier n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idComposition.custodian.identifier.systemShort description n/a DefinitionThe namespace for the identifier value n/a Fixed Value: "http://ihis.sg/identifier/hci-code" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ C | 1..1 | string | There are no (further) constraints on this element Element idComposition.custodian.identifier.valueShort description n/a DefinitionHCI Code Business Logic: System to validate the record exists, otherwise reject the data submission Fixed Value: "123H04" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ C | 0..1 | string | There are no (further) constraints on this element Element idComposition.custodian.displayShort description n/a DefinitionHCI name from PCP master codeset list Sample Value: "Clinic ABC" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| section | C | 1..* | BackboneElement | Element idComposition.sectionShort description n/a DefinitionCare report section Must populate all sections The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url 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.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| code | 1..1 | CodeableConcept | Element idComposition.section.codeShort description n/a DefinitionType of section n/a Terminology 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 downstreams such as MCDR Classification of a section of a composition/document. DocumentSectionCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 1..* | Coding | Element idComposition.section.code.codingShort description n/a DefinitionCode defined by a terminology system n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ C | 1..1 | uriFixed Value | Element idComposition.section.code.coding.systemShort description n/a DefinitionIdentity of the terminology system n/a Fixed Value: "http://ihis.sg/ValueSet/hsg-carereport-section" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ C | 1..1 | code | Element idComposition.section.code.coding.codeShort description n/a DefinitionTerminology code n/a Refer to the "CareReportBusinessData" tab column C Sample Value: "section-general" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ C | 0..1 | string | Element idComposition.section.code.coding.displayShort description n/a DefinitionDisplay name of the code n/a Refer to the "CareReportBusinessData" tab column C Sample Value: "section-general" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| author | C | 0..0 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| focus | C | 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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: ele-1, 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| entry | C | 1..* | Reference(Resource) | Element idComposition.section.entryShort description n/a DefinitionA reference to data that supports this section This represents the care report data element, must populate all elements (Refer to the "CareReportBusinessData"), regardless there is value or not The cardinality or value of this element may be affected by these constraints: ele-1, 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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| reference | Σ C | 1..1 | string | Element idComposition.section.entry.referenceShort description n/a DefinitionA reference from one resource to another actual data element under the respective section Local reference to the specific contained Obeservation resource which contains the actual care report data Sample Value: "#6288049DA16048D8A96B25CD8BB33630" The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 Constraints
| ||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| 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: ele-1, 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 Mappings
|
| profile-Composition-care-report-patient (Patient) | C | Patient | Element idPatientShort description n/a Alternate namesSubjectOfCare Client Resident DefinitionSection "resourceType" below is for "Patient" Patient resource can be populated only once
| |||
| id | Σ | 1..1 | id | Element idPatient.idShort description n/a DefinitionLogical id of this artifact The unique value of contained resource, it must match with the section.entry.reference Sample Value: "B35F55D095F64C95B6A200D44498F47D" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..0 | Meta | There are no (further) constraints on this element Element idPatient.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..0 | uri | There are no (further) constraints on this element Element idPatient.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..0 | codeBinding | There are no (further) constraints on this element Element idPatient.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
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..0 | Narrative | There are no (further) constraints on this element Element idPatient.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | C | 0..0 | Resource | There are no (further) constraints on this element Element idPatient.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources 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.
| ||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idPatient.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 resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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 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 idPatient.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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 1..1 | Identifier | Element idPatient.identifierShort description n/a DefinitionAn identifier for this patient n/a Patient NRIC The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idPatient.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 idPatient.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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idPatient.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.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) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idPatient.identifier.systemShort description n/a DefinitionNamespace of the patient identifier to ensure global uniqueness, and indicate the type of patient identifier specified in 'value' attribute. For the Healther SG, fixed to namespace for NRIC n/a Fixed Value: "http://ihis.sg/identifier/nric" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://ihis.sg/identifier/nricExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | Element idPatient.identifier.valueShort description n/a DefinitionPatient NRIC n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idPatient.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | Σ ?! | 0..0 | boolean | There are no (further) constraints on this element Element idPatient.activeShort description Whether this patient's record is in active use DefinitionWhether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. Need to be able to mark a patient record as not to be used because it was created in error. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. This resource is generally assumed to be active if no value is provided for the active element The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 1..1 | HumanName | Element idPatient.nameShort description n/a DefinitionA name associated with the patient n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idPatient.name.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 idPatient.name.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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..0 | codeBinding | There are no (further) constraints on this element Element idPatient.name.useShort description usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ C | 1..1 | string | Element idPatient.name.textShort description n/a DefinitionText representation of the full name n/a Sample Value: "Tan Ah Kau" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| family | Σ | 0..0 | string | There are no (further) constraints on this element Element idPatient.name.familyShort description Family name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| given | Σ | 0..0 | string | There are no (further) constraints on this element Element idPatient.name.givenShort description Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| prefix | Σ | 0..0 | string | There are no (further) constraints on this element Element idPatient.name.prefixShort description Parts that come before the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| suffix | Σ | 0..0 | string | There are no (further) constraints on this element Element idPatient.name.suffixShort description Parts that come after the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idPatient.name.periodShort description Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| telecom | Σ C | 0..0 | ContactPoint | There are no (further) constraints on this element Element idPatient.telecomShort description A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| gender | Σ | 1..1 | codeBinding | Element idPatient.genderShort description n/a DefinitionFhir Valueset of Administrative Gender n/a Sample Value: "male" The gender of a person used for administrative purposes. AdministrativeGender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| birthDate | Σ | 1..1 | date | Element idPatient.birthDateShort description n/a DefinitionThe date of birth for the individual n/a Validation: The expected format is 'YYYY-MM-DD' Sample Value: "2021-10-21" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| deceased[x] | Σ ?! | 0..0 | There are no (further) constraints on this element Element idPatient.deceased[x]Short description Indicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not. The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| address | Σ | 0..0 | Address | There are no (further) constraints on this element Element idPatient.addressShort description An address for the individual DefinitionAn address for the individual. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. Patient may have multiple addresses with different uses or applicable periods. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| maritalStatus | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatusShort description Marital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status. Most, if not all systems capture it. 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. The domestic partnership status of a person. Marital Status Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| multipleBirth[x] | 0..0 | There are no (further) constraints on this element Element idPatient.multipleBirth[x]Short description Whether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
| photo | C | 0..0 | Attachment | There are no (further) constraints on this element Element idPatient.photoShort description Image of the patient DefinitionImage of the patient. Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Guidelines:
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| contact | C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.contactShort description A contact party (e.g. guardian, partner, friend) for the patient DefinitionA contact party (e.g. guardian, partner, friend) for the patient. Need to track people you can contact about the patient. Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| communication | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.communicationShort description A language which may be used to communicate with the patient about his or her health DefinitionA language which may be used to communicate with the patient about his or her health. If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest. If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| generalPractitioner | C | 0..0 | Reference(Organization | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idPatient.generalPractitionerShort description Patient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider. This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. Reference(Organization | Practitioner | PractitionerRole) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| managingOrganization | Σ C | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.managingOrganizationShort description Organization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record. Need to know who recognizes this patient record, manages and updates it. There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| link | Σ ?! | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient.linkShort description Link to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient. There are multiple use cases:
There is no assumption that linked patient records have mutual links. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
| profile-Composition-care-report-observation (Observation) | C | Observation | Element idObservationShort description n/a Alternate namesVital Signs, Measurement, Results, Tests DefinitionSection "resourceType" below is for "Observation" Observation resource can be repeated for the same patient
| |||
| id | Σ | 1..1 | id | Element idObservation.idShort description n/a DefinitionLogical id of this artifact The unique value of contained resource, it must match with the section.entry.reference Sample Value: "DE7C2B8F575F46B792C20D542E01A4B1" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..0 | Meta | There are no (further) constraints on this element Element idObservation.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..0 | uri | There are no (further) constraints on this element Element idObservation.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..0 | codeBinding | There are no (further) constraints on this element Element idObservation.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
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..0 | Narrative | There are no (further) constraints on this element Element idObservation.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | C | 0..0 | Resource | There are no (further) constraints on this element Element idObservation.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources 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.
| ||
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idObservation.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 resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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 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 idObservation.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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idObservation.identifierShort description Business Identifier for observation DefinitionA unique identifier assigned to this observation. Allows observations to be distinguished and referenced. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | Σ C | 0..0 | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | There are no (further) constraints on this element Element idObservation.basedOnShort description Fulfills plan, proposal or order Alternate namesFulfills DefinitionA plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| partOf | Σ C | 0..0 | Reference(ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | MedicationStatement | Procedure) | There are no (further) constraints on this element Element idObservation.partOfShort description Part of referenced event Alternate namesContainer DefinitionA larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. To link an Observation to an Encounter use Reference(ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | MedicationStatement | Procedure) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBindingFixed Value | Element idObservation.statusShort description n/a DefinitionStaus of obeservation n/a Fixed Value: "final" Codes providing the status of an observation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
finalMappings
| ||
| category | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.categoryShort description Classification of type of observation DefinitionA code that classifies the general type of observation being made. Used for filtering what observations are retrieved and displayed. In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. Codes for high level observation categories. ObservationCategoryCodes (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| code | Σ | 1..1 | CodeableConcept | Element idObservation.codeShort description n/a Alternate namesName DefinitionType of observation n/a Terminology code for representing the data element name such as "diagnosis-code" and "complication-code" so that SOE systems can specify the correct value that can be understood by downstream systems such as MCDR Codes identifying names of simple observations. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idObservation.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 idObservation.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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 0..2 | Coding | Element idObservation.code.codingShort description n/a DefinitionCode defined by a terminology system n/a n/a The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..0 | id | There are no (further) constraints on this element Element idObservation.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 idObservation.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 ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uri | Element idObservation.code.coding.systemShort description n/a DefinitionIdentity of the terminology system n/a Sample Value: "http://ihis.sg/ValueSet/hsg-carereport-element" "http://loinc.org" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idObservation.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | code | Element idObservation.code.coding.codeShort description n/a DefinitionSymbol in syntax defined by the system n/a Refer to the 'CareRportBusinessData' tab column G, F Sample Value: "diagnosis-code", "1558-6" (loinc code) The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..1 | string | Element idObservation.code.coding.displayShort description n/a DefinitionRepresentation defined by the system n/a Refer to the 'CareReportBusinessData' tab column H Sample Value: "Disgnosi Code" The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
Sample Value Diagnosis CodeMappings
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idObservation.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idObservation.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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | Σ C | 0..0 | Reference(Device | Group | Location | Medication | Organization | Patient | Practitioner | Procedure | Substance) | There are no (further) constraints on this element Element idObservation.subjectShort description Who and/or what the observation is about DefinitionThe patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the Observations have no value if you don't know who or what they're about. One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. Reference(Device | Group | Location | Medication | Organization | Patient | Practitioner | Procedure | Substance) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| focus | Σ C | 0..0 | Reference(Resource) | There are no (further) constraints on this element Element idObservation.focusShort description What the observation is about, when it is not about the subject of record DefinitionThe actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| encounter | Σ C | 0..0 | Reference(Encounter) | There are no (further) constraints on this element Element idObservation.encounterShort description Healthcare event during which this observation is made Alternate namesContext DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. For some observations it may be important to know the link between an observation and a particular encounter. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| effective[x] | Σ | 0..0 | There are no (further) constraints on this element Element idObservation.effective[x]Short description Clinically relevant time/time-period for observation Alternate namesOccurrence DefinitionThe time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. Knowing when an observation was deemed true is important to its relevance as well as determining trends. At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| issued | Σ | 0..0 | instant | There are no (further) constraints on this element Element idObservation.issuedShort description Date/Time this version was made available DefinitionThe date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. For Observations that don’t require review and verification, it may be the same as the The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| performer | Σ C | 0..0 | Reference(CareTeam | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idObservation.performerShort description Who is responsible for the observation DefinitionWho was responsible for asserting the observed value as "true". May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareTeam | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value[x] | Σ C | 0..1 | Element idObservation.value[x]Short description n/a DefinitionValue of the data element. Depending on the data type of the data element, use the respective FHIR data type. Refer to sample payload for how to construct this section n/a Choice element Depends on the actual care report data, only 1 of below type chosen for the value type The cardinality or value of this element may be affected by these constraints: ele-1, obs-7 Constraints
| |||
| valueBoolean | profile-Composition-get-care-report-valueBoolean | Data type | ||||
| valueCodeableConcept | profile-Composition-get-care-report-valueCodeableConcept | Data type | ||||
| valueDateTime | profile-Composition-get-care-report-valueDateTime | Data type | ||||
| valueInteger | profile-Composition-get-care-report-valueInteger | Data type | ||||
| valueQuantity | profile-Composition-get-care-report-valueQuantity | Data type | ||||
| valueString | profile-Composition-get-care-report-valueString | Data type | ||||
| valueTime | profile-Composition-get-care-report-valueTime | Data type | ||||
| dataAbsentReason | C | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.dataAbsentReasonShort description Why the result is missing DefinitionProvides a reason why the expected value in the element Observation.value[x] is missing. For many results it is necessary to handle exceptional values in measurements. Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. Codes specifying why the result ( The cardinality or value of this element may be affected by these constraints: ele-1, obs-6 Constraints
| ||
| interpretation | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idObservation.interpretationShort description High, low, normal, etc. Alternate namesAbnormal Flag DefinitionA categorical assessment of an observation value. For example, high, low, normal. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Codes identifying interpretations of observations. ObservationInterpretationCodes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| note | 0..0 | Annotation | There are no (further) constraints on this element Element idObservation.noteShort description Comments about the observation DefinitionComments about the observation or the results. Need to be able to provide free text additional information. May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| bodySite | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idObservation.bodySiteShort description Observed body part DefinitionIndicates the site on the subject's body where the observation was made (i.e. the target site). Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite. SNOMED CT Body site concepts SNOMEDCTBodyStructures (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| method | 0..0 | CodeableConcept | There are no (further) constraints on this element Element idObservation.methodShort description How it was done DefinitionIndicates the mechanism used to perform the observation. In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. Only used if not implicit in code for Observation.code. Methods for simple observations. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| specimen | C | 0..0 | Reference(Specimen) | There are no (further) constraints on this element Element idObservation.specimenShort description Specimen used for this observation DefinitionThe specimen that was used when this observation was made. Should only be used if not implicit in code found in The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| device | C | 0..0 | Reference(Device | DeviceMetric) | There are no (further) constraints on this element Element idObservation.deviceShort description (Measurement) Device DefinitionThe device used to generate the observation data. Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. Reference(Device | DeviceMetric) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| referenceRange | C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idObservation.referenceRangeShort description Provides guide for interpretation DefinitionGuidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| hasMember | Σ C | 0..0 | Reference(MolecularSequence | Observation | QuestionnaireResponse) | There are no (further) constraints on this element Element idObservation.hasMemberShort description Related resource that belongs to the Observation group DefinitionThis observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see Notes below. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation. Reference(MolecularSequence | Observation | QuestionnaireResponse) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| derivedFrom | Σ C | 0..0 | Reference(DocumentReference | ImagingStudy | Media | MolecularSequence | Observation | QuestionnaireResponse) | There are no (further) constraints on this element Element idObservation.derivedFromShort description Related measurements the observation is made from DefinitionThe target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below. Reference(DocumentReference | ImagingStudy | Media | MolecularSequence | Observation | QuestionnaireResponse) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| component | Σ | 0..0 | BackboneElement | There are no (further) constraints on this element Element idObservation.componentShort description Component results DefinitionSome observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. For a discussion on the ways Observations can be assembled in groups together see Notes below. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Error Response
Click here for General API Error Handling
Custom Error Codes
Refer to Custom Error Codes for the list of custom error codes specific to this API.