HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)

This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions

ObservationContextModel

Definitions for cimi-context-ObservationContext-model.

cimi-context-ObservationContext-model
Definition

Context for recording an evaluation result, used to indicate an evaluation has been made.

Control0..*
cimi-context-ObservationContext-model.contextCode
Definition

A code representing the ontological status of the statement, e.g., whether it exists, does not exist, is planned, etc. Attribute aligns with the SNOMED CT Situation with Explicit Context (SWEC) Concept Model context attributes: 'Finding context (attribute)' (SCTID: 408729009) and 'Procedure context (attribute)' (SCTID: 408730004). The range allowed for this attribute shall be consistent with the SNOMED CT concept model specification for SWEC.

Control1..1
TypeCoding
cimi-context-ObservationContext-model.contextCode.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
cimi-context-ObservationContext-model.contextCode.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

cimi-context-ObservationContext-model.contextCode.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://snomed.info/sct
cimi-context-ObservationContext-model.contextCode.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

cimi-context-ObservationContext-model.contextCode.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Requirements

Need to refer to a particular code in the system.

Fixed Value424975005
cimi-context-ObservationContext-model.contextCode.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

cimi-context-ObservationContext-model.contextCode.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

cimi-context-ObservationContext-model.encounter
Definition

A description of an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

Control0..1
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-encounter-Encounter-model
cimi-context-ObservationContext-model.interpretation
Definition

A clinical interpretation of a finding (applies to both assertions and observation).

Control0..1
BindingThe codes SHALL be taken from Observation Interpretation Codes; other codes may be used where these codes are not suitable
TypeCoding
cimi-context-ObservationContext-model.findingStatus
Definition

Indicates whether the finding is preliminary, amended, final, etc.

Control1..1
BindingThe codes SHALL be taken from ObservationStatus
Typecode
cimi-context-ObservationContext-model.relevantTime
Definition

The time or time period that the finding addresses. The clinically relevant time is not necessarily when the information is gathered or when a test is carried out, but for example, when a specimen was collected, or the time period referred to by the question. Use a TimePeriod for a measurement or specimen collection continued over a significant period of time (e.g. 24 hour Urine Sodium).

Control0..1
TypeChoice of: dateTime, http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriod-model
cimi-context-ObservationContext-model.resultValue
Definition

The finding itself, such as the blood pressure value recorded.

Control0..1
TypeChoice of: http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Quantity-model, Coding, string, boolean, http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Range-model, http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Ratio-model, time, dateTime, http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriod-model
cimi-context-ObservationContext-model.exceptionValue
Definition

Reason that a value associated with a test or other finding is missing.

Control0..1
BindingThe codes SHALL be taken from DataAbsentReason; other codes may be used where these codes are not suitable
TypeCoding
cimi-context-ObservationContext-model.deltaFlag
Definition

Indicator of significant change (delta) from the last or previous measurement.

Control0..1
BindingThe codes SHALL be taken from DeltaFlagVS
TypeCoding
cimi-context-ObservationContext-model.issued
Definition

The date and time this observation was made available to providers, typically after the results have been reviewed and verified.

Control0..1
Typeinstant
cimi-context-ObservationContext-model.observer
Definition

The person or organization who observed or informed the reporter about the characteristic, potentially the clinician, the patient, or a related person.

Control0..*
TypeReference(PractitionerModel | OrganizationModel | PatientModel | RelatedPersonModel)