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

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

SimplifiedLaboratoryTestResultRecordedModel - Detailed Descriptions

Definitions for cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.

cimi-statement-SimplifiedLaboratoryTestResultRecorded-model
Definition

The usual case for a test result from a pathology lab, based on a specimen taken from a patient. Note that the body site is not explicit here; it is part of the specimen resource associated with the lab result.

Control0..*
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic
Definition

The base class, independent of context, for evaluations (measurements, tests, or questions) and a value containing the result (answer).

The subject of a finding can be the entire patient, or an entity such as a location body structure, intervention, or condition. Things observed about the subject can include social and behavioral factors, subjective and objective observations, and assessments.

CIMI Alignment: 1) In CIMI V0.0.4, LaboratoryTestResult.specimen is 0.. but that cardinality makes it impossible to map to FHIR Observation, where specimen is 0..1. The cardinality of Specimen has been changed to 0..1 to enable FHIR mapping. 2) In CIMI V0.0.4, Findings (including EvaluationResult and LaboratoryTestResult) do not have related ('has-member') observations, nor components (sub-observations). These features of FHIR Observations were found to be very useful in modeling breast cancer pathology, and are included here. This represents a significant departure from the CIMI model. CompoundClinicalStatement has not been used to represent panel-like findings, because of the complexity of mapping this class to FHIR. 3) In CIMI V0.0.4, allowable datatypes for result (aka Value) include EmbeddedContent, GpsLocation, Multimedia, ParsableContent, and other types not allowed in a FHIR Observation. To make mapping feasible, the types of Value were restricted to only the allowable FHIR datatypes. 4) ExceptionValue has been moved to the RecordedContext, because it is only relevant when a value is supposed to be recorded, but is not. 5) The cardinality of FindingMethod has been changed from 0.. to 0..1 to make it possible to map to FHIR, where Observation.method is 0..1. 6) The class PhysicalEvaluationResult has been united with this class, and the body location (AnatomicalLocation) has been added to this class. This is because bodySite is part of Observation, and it cannot be profiled out of EvaluationResult and then re-included in PhysicalEvaluationResult. 7) The cardinality of AnatomicalLocation has been changed from 0..* to 0..1 to make it possible to map to FHIR, where Observation.bodySite is 0..1. 8) The attribute evaluationDate has been moved to RecordedContext, because it only applies to evaluations that have been done. 9) The attributes device and evaluationProcedure have been removed for brevity, since they are not used in the current IG.

Control1..1
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-EvaluationResultTopic-model
Alternate NamesstatementTopic
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.value[x]
Definition

Choice of types representing the base class, independent of context, for evaluations (measurements, tests, or questions) and a value containing the result (answer).

The subject of a finding can be the entire patient, or an entity such as a location body structure, intervention, or condition. Things observed about the subject can include social and behavioral factors, subjective and objective observations, and assessments.

CIMI Alignment: 1) In CIMI V0.0.4, LaboratoryTestResult.specimen is 0.. but that cardinality makes it impossible to map to FHIR Observation, where specimen is 0..1. The cardinality of Specimen has been changed to 0..1 to enable FHIR mapping. 2) In CIMI V0.0.4, Findings (including EvaluationResult and LaboratoryTestResult) do not have related ('has-member') observations, nor components (sub-observations). These features of FHIR Observations were found to be very useful in modeling breast cancer pathology, and are included here. This represents a significant departure from the CIMI model. CompoundClinicalStatement has not been used to represent panel-like findings, because of the complexity of mapping this class to FHIR. 3) In CIMI V0.0.4, allowable datatypes for result (aka Value) include EmbeddedContent, GpsLocation, Multimedia, ParsableContent, and other types not allowed in a FHIR Observation. To make mapping feasible, the types of Value were restricted to only the allowable FHIR datatypes. 4) ExceptionValue has been moved to the RecordedContext, because it is only relevant when a value is supposed to be recorded, but is not. 5) The cardinality of FindingMethod has been changed from 0.. to 0..1 to make it possible to map to FHIR, where Observation.method is 0..1. 6) The class PhysicalEvaluationResult has been united with this class, and the body location (AnatomicalLocation) has been added to this class. This is because bodySite is part of Observation, and it cannot be profiled out of EvaluationResult and then re-included in PhysicalEvaluationResult. 7) The cardinality of AnatomicalLocation has been changed from 0..* to 0..1 to make it possible to map to FHIR, where Observation.bodySite is 0..1. 8) The attribute evaluationDate has been moved to RecordedContext, because it only applies to evaluations that have been done. 9) The attributes device and evaluationProcedure have been removed for brevity, since they are not used in the current IG.

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
[x] NoteSee Choice of Data Types for further information about how to use [x]
Alternate Namesquantity, codeableConcept, string, boolean, range, ratio, time, dateTime, timePeriod
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.topicCode
Definition

The concept representing the finding or action that is the topic of the statement.

For action topics, the TopicCode represents the action being described. For findings, the TopicCode represents the 'question' or property being investigated. For evaluation result findings, the TopicCode contains a concept for an observable entity, such as systolic blood pressure. For assertion findings, the TopicCode contains a code representing the condition, allergy, or other item being asserted. In all cases, the TopicCode describes the topic independent of the context of the action or the finding.

CIMI Alignment: TopicCode is the new CIMI name for the attribute formerly called 'key' in CIMI V0.0.4.

Control1..1
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-TopicCode-model
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.findingMethod
Definition

The technique used to create the finding; for example, the specific imaging technique, lab test code, or assessment vehicle.

CIMI Alignment: In CIMI V0.0.4, this attribute was called 'method'. The value set binding reflects CIMI's preference for LOINC codes.

Control0..1
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-FindingMethod-model
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.interpretation
Definition

A clinical interpretation of a finding.

CIMI Alignment: The value set binding has been chosen to align with FHIR. (Note: it is not clear if Interpretation belongs in FindingTopic, rather than a context class, but that is how CIMI has modeled it.)

Control0..1
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-Interpretation-model
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.category
Definition

A class or division of people or things having particular shared characteristics

Control1..*
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Category-model
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.category.value
Definition

Code representing a class or division of people or things having particular shared characteristics

Control1..1
TypeCoding
Alternate NamescodeableConcept
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.category.value.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-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.category.value.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
Alternate Namesextensions, user content
Comments

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

cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.category.value.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://hl7.org/fhir/observation-category
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.category.value.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-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.category.value.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 Valuelaboratory
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.category.value.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-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.category.value.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-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.anatomicalLocation
Definition

A location or structure in the body, including tissues, regions, cavities, and spaces; for example, right elbow, or left ventricle of the heart.

CIMI Alignment: In CIMI V0.0.4, AnatomicalLocation has no parent class. This appears to have been an oversight, and the parent should have been Entity, as modeled here.

Control0..0
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-AnatomicalLocation-model
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.specimen
Definition

A specimen is a substance, physical object, or collection of objects, that the laboratory considers a single discrete, uniquely identified unit that is the subject of one or more steps in the laboratory workflow. A specimen may include multiple physical pieces as long as they are considered a single unit within the laboratory workflow. A specimen results from one to many specimen collection procedures, and may be contained in multiple specimen containers. Specimen may have one or more processing activities.

CIMI Alignment: This class has been cut down to parts relevant to the current oncology ballot. The attribute parentSpecimenIdentifier has been changed from an Identifier to a reference to a Specimen, to make it possible to map to FHIR.

Control0..1
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-Specimen-model
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.deltaFlag
Definition

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

Control0..1
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-DeltaFlag-model
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.precondition
Definition

A description of the conditions or context of an observation; for example, under sedation, fasting or post-exercise.

Body position and body site are also qualifiers, but handled separately. A qualifier cannot modify the measurement type; for example, a fasting blood sugar is still a blood sugar.

Control0..0
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-Precondition-model
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.referenceRange
Definition

The usual or acceptable range for a test result.

Control0..0
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-ReferenceRange-model
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.evaluationResultTopic.evaluationComponent
Definition

A simplified, non-separable evaluation consisting of a finding code (represented by the Concept), value (or exception value), reference range, and interpretation.

The subject of the evaluation component is the same as in the parent evaluation.

Control0..*
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-EvaluationComponent-model
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.recordedContext
Definition

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

For example, measurement of blood pressure that has been made simply exists (although the value can be present or absent, accurate or inaccurate). The RecordedContext indicates the information presented stands on its own as presented. It can also apply to clinical notes.

CIMI Alignment: The RecordedContext class did not exist in CIMI V0.0.4, but CIMI has recently added it.

Control1..1
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-RecordedContext-model
Alternate NamesstatementContext
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.encounter
Definition

An abstract class that represents an encounter class. This class has been stubbed out to limit the scope of this implementation guide to classes relevant to this ballot concerning breast cancer.

Control0..1
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-Encounter-model
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.members
Definition

Members represent the elements of a group of a related but independent evaluations.

Examples are the measurements that compose a complete blood count (CBC), or the elements of a pathology report. Each member is an independent evaluation, but the grouping reflects a composite lab order, shared specimen, or a single report author. Typically the Category and Reason are not given for individual findings that are part of the panel, but rather given at the level of the panel itself. Although the proper place to define Members this might be in EvaluationResultTopic, it cannot be defined there because the value references EvaluationResultRecorded, which is a clinical statement class.

CIMI Alignment: CIMI V0.0.4 does not have this attribute and uses CompoundClinicalStatement to create panels. Compared to having a separate class, the current representation closer alignment with FHIR and greater flexibility (related observations can be added to any observation).

Control0..0
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-statement-Members-model
cimi-statement-SimplifiedLaboratoryTestResultRecorded-model.diagnosticService
Definition

A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.

Control0..*
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-statement-DiagnosticService-model