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

LymphNodeSizeModel

Definitions for oncology-LymphNodeSize-model.

oncology-LymphNodeSize-model
Definition

Size of the lymph node or lymph node group which is being clinically assessed.

Control0..*
oncology-LymphNodeSize-model.value
Definition

Quantity representing size of the lymph node or lymph node group which is being clinically assessed.

Control1..1
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Quantity-model
oncology-LymphNodeSize-model.value.value
Definition

Decimal representing a quantity with units, whose value may be bounded from above or below, as defined in FHIR

Control0..1
Typedecimal
oncology-LymphNodeSize-model.value.comparator
Definition

Comparator

Control0..1
BindingThe codes SHALL be taken from QuantityComparator
Typecode
oncology-LymphNodeSize-model.value.units
Definition

Code for the unit of measure of the quantity.

Control0..1
TypeCoding
oncology-LymphNodeSize-model.value.units.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
oncology-LymphNodeSize-model.value.units.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.

oncology-LymphNodeSize-model.value.units.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://unitsofmeasure.org
oncology-LymphNodeSize-model.value.units.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.

oncology-LymphNodeSize-model.value.units.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 Valuemm
oncology-LymphNodeSize-model.value.units.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.

oncology-LymphNodeSize-model.value.units.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.

oncology-LymphNodeSize-model.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.

Control0..1
TypeCoding
oncology-LymphNodeSize-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
oncology-LymphNodeSize-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
oncology-LymphNodeSize-model.referenceRange
Definition

The usual or acceptable range for a test result.

Control0..*
Typehttp://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-topic-ReferenceRange-model