HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.0

- Local Development build (v0.9.0). See the Directory of published versions

TNMClinicalRegionalNodesCategory

 

The official URL for this profile is:

http://hl7.org/fhir/us/shr/StructureDefinition/onco-core-TNMClinicalRegionalNodesCategory

Category of the presence or absence of metastases in regional lymph nodes, assessed using tests that are done before surgery. These include physical exams, imaging tests, laboratory tests (such as blood tests), and biopsies (definition adapted from NCI Dictionary of Cancer Terms).

This profile builds on Observation.

This profile was published on Wed Apr 17 00:00:00 EDT 2019 as a draft by The MITRE Corporation.

Summary

Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 3 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.code.coding is sliced based on the value of value:code

Mapping Source

This structure represents the following mapping definition:

onco.core.TNMClinicalRegionalNodesCategory maps to Observation:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Identifier maps to identifier
  PatientSubjectOfRecord maps to subject
  PractitionerPerformer maps to performer
  Code maps to code
  CancerStagingSystem maps to method
  CommentOrDescription maps to comments
  Category maps to category
  BodyLocation.LocationCode maps to bodySite
  BodyLocation.Laterality maps to bodySite.extension
  BodyLocation.Orientation maps to bodySite.extension
  BodyLocation.RelationToLandmark maps to bodySite.extension
  Device maps to device
  StatementDateTime maps to issued
  ReferenceRange maps to referenceRange
  ReferenceRange.Range.LowerBound maps to referenceRange.low
  ReferenceRange.Range.UpperBound maps to referenceRange.high
  ReferenceRange.Type maps to referenceRange.meaning
  Components.ObservationComponent maps to component (slice on = code.coding.code; slice strategy = includes)
  Components.ObservationComponent.Code maps to component.code
  Components.ObservationComponent.DataValue maps to component.value[x]
  Components.ObservationComponent.DataAbsentReason maps to component.dataAbsentReason
  Components.ObservationComponent.ReferenceRange maps to component.referenceRange
  fix related.type to #has-member
  PanelMembers maps to related
  PanelMembers.Observation maps to related.target (slice at = related; slice on = target.reference.resolve(); slice on type = profile; slice strategy = includes)
  DataValue maps to value[x]
  DataAbsentReason maps to dataAbsentReason
  Interpretation maps to interpretation
  Status maps to status
  RelevantTime maps to effective[x]
  CareContext maps to encounter
  constrain specimen to 0..0

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation onco-core-TNMClinicalRegionalNodesCategory
... extension Slice: Unordered, Open by value:url
... onco-core-PrimaryCancerCondition-extension 0..1Reference(onco-core-PrimaryCancerCondition)PrimaryCancerCondition
URL: http://hl7.org/fhir/us/shr/StructureDefinition/onco-core-PrimaryCancerCondition-extension
... category Binding: Observation Category Codes (extensible)
... code
.... coding Slice: Unordered, Open by value:code
.... coding Σ1..1CodingRegional lymph nodes.clinical [Class] Cancer
..... system Fixed Value: http://loinc.org
..... code Fixed Value: 21906-3
... subject 1..1Reference(shr-core-Patient)
... encounter Reference(shr-core-Encounter)
... effective[x] S
... performer Reference(shr-core-Practitioner)
... valueCodeableConcept SCodeableConceptBinding: TNMRegionalNodesCategoryVS (preferred)
... dataAbsentReason 0..0
... bodySite 0..0
... method Binding: CancerStagingSystemVS (extensible)
... specimen 0..0
... device 0..0
... referenceRange 0..0
... related 0..0
... component 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*onco-core-TNMClinicalRegionalNodesCategory
obs-6: SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... onco-core-PrimaryCancerCondition-extension 0..1Reference(onco-core-PrimaryCancerCondition)PrimaryCancerCondition
URL: http://hl7.org/fhir/us/shr/StructureDefinition/onco-core-PrimaryCancerCondition-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierUnique Id for this particular observation
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (extensible)
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: LOINC Codes (example)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:code
.... coding Σ1..1CodingRegional lymph nodes.clinical [Class] Cancer
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: 21906-3
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject Σ1..1Reference(shr-core-Patient)Who and/or what this is about
... encounter 0..1Reference(shr-core-Encounter)Healthcare event during which this observation is made
... effective[x] SΣ0..1dateTime, PeriodClinically relevant time/time-period for observation
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference(shr-core-Practitioner)Who is responsible for the observation
... valueCodeableConcept SΣ1..1CodeableConceptActual result
Binding: TNMRegionalNodesCategoryVS (preferred)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comments 0..1stringComments about result
... method 0..1CodeableConceptHow it was done
Binding: CancerStagingSystemVS (extensible)

doco Documentation for this format

Summary

Mandatory: 0 element (3 nested mandatory elements)
Must-Support: 2 elements
Fixed Value: 3 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.code.coding is sliced based on the value of value:code

Mapping Source

This structure represents the following mapping definition:

onco.core.TNMClinicalRegionalNodesCategory maps to Observation:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Identifier maps to identifier
  PatientSubjectOfRecord maps to subject
  PractitionerPerformer maps to performer
  Code maps to code
  CancerStagingSystem maps to method
  CommentOrDescription maps to comments
  Category maps to category
  BodyLocation.LocationCode maps to bodySite
  BodyLocation.Laterality maps to bodySite.extension
  BodyLocation.Orientation maps to bodySite.extension
  BodyLocation.RelationToLandmark maps to bodySite.extension
  Device maps to device
  StatementDateTime maps to issued
  ReferenceRange maps to referenceRange
  ReferenceRange.Range.LowerBound maps to referenceRange.low
  ReferenceRange.Range.UpperBound maps to referenceRange.high
  ReferenceRange.Type maps to referenceRange.meaning
  Components.ObservationComponent maps to component (slice on = code.coding.code; slice strategy = includes)
  Components.ObservationComponent.Code maps to component.code
  Components.ObservationComponent.DataValue maps to component.value[x]
  Components.ObservationComponent.DataAbsentReason maps to component.dataAbsentReason
  Components.ObservationComponent.ReferenceRange maps to component.referenceRange
  fix related.type to #has-member
  PanelMembers maps to related
  PanelMembers.Observation maps to related.target (slice at = related; slice on = target.reference.resolve(); slice on type = profile; slice strategy = includes)
  DataValue maps to value[x]
  DataAbsentReason maps to dataAbsentReason
  Interpretation maps to interpretation
  Status maps to status
  RelevantTime maps to effective[x]
  CareContext maps to encounter
  constrain specimen to 0..0

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation onco-core-TNMClinicalRegionalNodesCategory
... extension Slice: Unordered, Open by value:url
... onco-core-PrimaryCancerCondition-extension 0..1Reference(onco-core-PrimaryCancerCondition)PrimaryCancerCondition
URL: http://hl7.org/fhir/us/shr/StructureDefinition/onco-core-PrimaryCancerCondition-extension
... category Binding: Observation Category Codes (extensible)
... code
.... coding Slice: Unordered, Open by value:code
.... coding Σ1..1CodingRegional lymph nodes.clinical [Class] Cancer
..... system Fixed Value: http://loinc.org
..... code Fixed Value: 21906-3
... subject 1..1Reference(shr-core-Patient)
... encounter Reference(shr-core-Encounter)
... effective[x] S
... performer Reference(shr-core-Practitioner)
... valueCodeableConcept SCodeableConceptBinding: TNMRegionalNodesCategoryVS (preferred)
... dataAbsentReason 0..0
... bodySite 0..0
... method Binding: CancerStagingSystemVS (extensible)
... specimen 0..0
... device 0..0
... referenceRange 0..0
... related 0..0
... component 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*onco-core-TNMClinicalRegionalNodesCategory
obs-6: SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... onco-core-PrimaryCancerCondition-extension 0..1Reference(onco-core-PrimaryCancerCondition)PrimaryCancerCondition
URL: http://hl7.org/fhir/us/shr/StructureDefinition/onco-core-PrimaryCancerCondition-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierUnique Id for this particular observation
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (extensible)
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: LOINC Codes (example)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding ΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:code
.... coding Σ1..1CodingRegional lymph nodes.clinical [Class] Cancer
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: 21906-3
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subject Σ1..1Reference(shr-core-Patient)Who and/or what this is about
... encounter 0..1Reference(shr-core-Encounter)Healthcare event during which this observation is made
... effective[x] SΣ0..1dateTime, PeriodClinically relevant time/time-period for observation
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference(shr-core-Practitioner)Who is responsible for the observation
... valueCodeableConcept SΣ1..1CodeableConceptActual result
Binding: TNMRegionalNodesCategoryVS (preferred)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comments 0..1stringComments about result
... method 0..1CodeableConceptHow it was done
Binding: CancerStagingSystemVS (extensible)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
Observation.valueCodeableConcept-CodeableConceptpreferredTNMRegionalNodesCategoryVS

 

Constraints

IdPathDetailsRequirements
obs-6ObservationSHALL only be present if Observation.value[x] is not present
:
obs-7ObservationComponent code SHALL not be same as observation code
: