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
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:
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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | onco-core-TNMClinicalRegionalNodesCategory | |||
  extension | Slice: Unordered, Open by value:url | |||
| onco-core-PrimaryCancerCondition-extension | 0..1 | Reference(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..1 | Coding | Regional lymph nodes.clinical [Class] Cancer |
  system | Fixed Value: http://loinc.org | |||
 code | Fixed Value: 21906-3 | |||
 subject | 1..1 | Reference(shr-core-Patient) | ||
| encounter | Reference(shr-core-Encounter) | |||
| effective[x] | S | |||
| performer | Reference(shr-core-Practitioner) | |||
| valueCodeableConcept | S | CodeableConcept | Binding: 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 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | I | 0..* | 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..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| onco-core-PrimaryCancerCondition-extension | 0..1 | Reference(onco-core-PrimaryCancerCondition) | PrimaryCancerCondition URL: http://hl7.org/fhir/us/shr/StructureDefinition/onco-core-PrimaryCancerCondition-extension | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | Unique Id for this particular observation | |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
| category | 0..1 | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (extensible) | |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINC Codes (example) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
| coding | Σ | 1..1 | Coding | Regional lymph nodes.clinical [Class] Cancer |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 21906-3 |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(shr-core-Patient) | Who and/or what this is about |
| encounter | 0..1 | Reference(shr-core-Encounter) | Healthcare event during which this observation is made | |
 effective[x] | SΣ | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation |
| issued | Σ | 0..1 | instant | Date/Time this was made available |
| performer | Σ | 0..* | Reference(shr-core-Practitioner) | Who is responsible for the observation |
| valueCodeableConcept | SΣ | 1..1 | CodeableConcept | Actual result Binding: TNMRegionalNodesCategoryVS (preferred) |
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
| comments | 0..1 | string | Comments about result | |
| method | 0..1 | CodeableConcept | How it was done Binding: CancerStagingSystemVS (extensible) | |
| 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:
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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | onco-core-TNMClinicalRegionalNodesCategory | |||
| extension | Slice: Unordered, Open by value:url | |||
| onco-core-PrimaryCancerCondition-extension | 0..1 | Reference(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..1 | Coding | Regional lymph nodes.clinical [Class] Cancer |
| system | Fixed Value: http://loinc.org | |||
| code | Fixed Value: 21906-3 | |||
| subject | 1..1 | Reference(shr-core-Patient) | ||
| encounter | Reference(shr-core-Encounter) | |||
| effective[x] | S | |||
| performer | Reference(shr-core-Practitioner) | |||
| valueCodeableConcept | S | CodeableConcept | Binding: 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 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | I | 0..* | 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..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| onco-core-PrimaryCancerCondition-extension | 0..1 | Reference(onco-core-PrimaryCancerCondition) | PrimaryCancerCondition URL: http://hl7.org/fhir/us/shr/StructureDefinition/onco-core-PrimaryCancerCondition-extension | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | Unique Id for this particular observation | |
| status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
| category | 0..1 | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (extensible) | |
| code | Σ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINC Codes (example) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
| coding | Σ | 1..1 | Coding | Regional lymph nodes.clinical [Class] Cancer |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 21906-3 |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(shr-core-Patient) | Who and/or what this is about |
| encounter | 0..1 | Reference(shr-core-Encounter) | Healthcare event during which this observation is made | |
| effective[x] | SΣ | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation |
| issued | Σ | 0..1 | instant | Date/Time this was made available |
| performer | Σ | 0..* | Reference(shr-core-Practitioner) | Who is responsible for the observation |
| valueCodeableConcept | SΣ | 1..1 | CodeableConcept | Actual result Binding: TNMRegionalNodesCategoryVS (preferred) |
| interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Observation Interpretation Codes (extensible) | |
| comments | 0..1 | string | Comments about result | |
| method | 0..1 | CodeableConcept | How it was done Binding: CancerStagingSystemVS (extensible) | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
| Path | Conformance | ValueSet |
| Observation.valueCodeableConcept-CodeableConcept | preferred | TNMRegionalNodesCategoryVS |
| Id | Path | Details | Requirements |
| obs-6 | Observation | SHALL only be present if Observation.value[x] is not present : | |
| obs-7 | Observation | Component code SHALL not be same as observation code : |