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

SimpleCodedNonLaboratoryObservation

 

The official URL for this profile is:

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

An observation whose result is a code, and also having no components or panel members

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 (1 nested mandatory element)
Fixed Value: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.SimpleCodedNonLaboratoryObservation 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
  ObservationSubjectOfRecord maps to subject
  Performer maps to performer
  Code maps to code
  Method 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 shr-core-SimpleCodedNonLaboratoryObservation
... category Binding: Observation Category Codes (extensible)
... subject 1..1Reference(shr-core-Patient | shr-core-Group | shr-core-Device | shr-core-Location)
... encounter Reference(shr-core-Encounter)
... performer Reference(shr-core-Practitioner | shr-core-Organization | shr-core-Patient | shr-core-RelatedPerson)
... valueCodeableConcept CodeableConcept
... dataAbsentReason Binding: DataAbsentReason (extensible)
... bodySite Binding: BodyLocationVS (preferred)
.... extension Slice: Unordered, Open by value:url
.... shr-core-Laterality-extension 0..1CodeableConceptLaterality
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Laterality-extension
Binding: LateralityVS (extensible)
.... shr-core-Orientation-extension 0..1CodeableConceptOrientation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Orientation-extension
Binding: OrientationVS (extensible)
.... shr-core-RelationToLandmark-extension 0..*(Complex)RelationToLandmark
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RelationToLandmark-extension
... specimen 0..0
... device Reference(shr-core-Device)
... referenceRange 0..0
... related 0..0
... component 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*shr-core-SimpleCodedNonLaboratoryObservation
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
... 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)
... subject Σ1..1Reference(shr-core-Patient | shr-core-Group | shr-core-Device | shr-core-Location)Who and/or what this is about
... encounter 0..1Reference(shr-core-Encounter)Healthcare event during which this observation is made
... effective[x] Σ0..1dateTime, PeriodClinically relevant time/time-period for observation
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference(shr-core-Practitioner | shr-core-Organization | shr-core-Patient | shr-core-RelatedPerson)Who is responsible for the observation
... valueCodeableConcept Σ0..1CodeableConceptActual result
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comments 0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: BodyLocationVS (preferred)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... shr-core-Laterality-extension 0..1CodeableConceptLaterality
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Laterality-extension
Binding: LateralityVS (extensible)
.... shr-core-Orientation-extension 0..1CodeableConceptOrientation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Orientation-extension
Binding: OrientationVS (extensible)
.... shr-core-RelationToLandmark-extension 0..*(Complex)RelationToLandmark
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RelationToLandmark-extension
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... device 0..1Reference(shr-core-Device)(Measurement) Device

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)
Fixed Value: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.SimpleCodedNonLaboratoryObservation 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
  ObservationSubjectOfRecord maps to subject
  Performer maps to performer
  Code maps to code
  Method 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 shr-core-SimpleCodedNonLaboratoryObservation
... category Binding: Observation Category Codes (extensible)
... subject 1..1Reference(shr-core-Patient | shr-core-Group | shr-core-Device | shr-core-Location)
... encounter Reference(shr-core-Encounter)
... performer Reference(shr-core-Practitioner | shr-core-Organization | shr-core-Patient | shr-core-RelatedPerson)
... valueCodeableConcept CodeableConcept
... dataAbsentReason Binding: DataAbsentReason (extensible)
... bodySite Binding: BodyLocationVS (preferred)
.... extension Slice: Unordered, Open by value:url
.... shr-core-Laterality-extension 0..1CodeableConceptLaterality
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Laterality-extension
Binding: LateralityVS (extensible)
.... shr-core-Orientation-extension 0..1CodeableConceptOrientation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Orientation-extension
Binding: OrientationVS (extensible)
.... shr-core-RelationToLandmark-extension 0..*(Complex)RelationToLandmark
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RelationToLandmark-extension
... specimen 0..0
... device Reference(shr-core-Device)
... referenceRange 0..0
... related 0..0
... component 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*shr-core-SimpleCodedNonLaboratoryObservation
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
... 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)
... subject Σ1..1Reference(shr-core-Patient | shr-core-Group | shr-core-Device | shr-core-Location)Who and/or what this is about
... encounter 0..1Reference(shr-core-Encounter)Healthcare event during which this observation is made
... effective[x] Σ0..1dateTime, PeriodClinically relevant time/time-period for observation
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference(shr-core-Practitioner | shr-core-Organization | shr-core-Patient | shr-core-RelatedPerson)Who is responsible for the observation
... valueCodeableConcept Σ0..1CodeableConceptActual result
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comments 0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: BodyLocationVS (preferred)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... shr-core-Laterality-extension 0..1CodeableConceptLaterality
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Laterality-extension
Binding: LateralityVS (extensible)
.... shr-core-Orientation-extension 0..1CodeableConceptOrientation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Orientation-extension
Binding: OrientationVS (extensible)
.... shr-core-RelationToLandmark-extension 0..*(Complex)RelationToLandmark
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RelationToLandmark-extension
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... device 0..1Reference(shr-core-Device)(Measurement) Device

doco Documentation for this format

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

 

 

Constraints

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