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

PlateletsNCncPtBldQnAutoCntLabObs

 

The official URL for this profile is:

http://hl7.org/fhir/us/shr/StructureDefinition/shr-lab-PlateletsNCncPtBldQnAutoCntLabObs

Platelets [#/​volume] in Blood by Automated count

This profile builds on http://fhir.org/guides/argonaut/StructureDefinition/argo-observationresults.

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

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Mapping Source

This structure represents the following mapping definition:

shr.lab.PlateletsNCncPtBldQnAutoCntLabObs maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-observationresults:
  _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 (slice on = type.coding.code; slice strategy = includes)
  ObservationSubjectOfRecord maps to subject
  PractitionerOrOrganizationPerformer maps to performer (slice on = target.reference.resolve(); slice on type = profile; slice strategy = includes)
  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
  Specimen maps to specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation shr-lab-PlateletsNCncPtBldQnAutoCntLabObs
... identifier Slice: Unordered, Open by value:type.coding.code
... identifier 0..1AccessionIdentifierAccessionIdentifier
... identifier 0..1FillerOrderNumberFillerOrderNumber
... identifier 0..1PlacerOrderNumberPlacerOrderNumber
... code
.... coding Slice: Unordered, Open by value:code
.... coding Σ1..1CodingPlatelets [#/​volume] in Blood by Automated count
..... system Fixed Value: http://loinc.org
..... code Fixed Value: 777-3
... subject Reference(shr-core-Patient)
... encounter Reference(shr-core-Encounter)
... performer Reference(shr-core-Practitioner | shr-core-Organization)
... valueQuantity QuantityWithRequiredUnitsBinding: EquivalentUnitsVS-thousand-per-uL (required)
... dataAbsentReason 0..0
... interpretation Binding: QuantitativeResultInterpretationVS (extensible)
... bodySite 0..0
... specimen Reference(shr-core-Specimen)
... device Reference(shr-core-Device)
... referenceRange 0..1
.... meaning Binding: Observation Reference Range Meaning Codes (extensible)
... related 0..0
... component 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*shr-lab-PlateletsNCncPtBldQnAutoCntLabObs
obs-6: SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
arg-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... 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 IdentifierUnique Id for this particular observation
Slice: Unordered, Open by value:type.coding.code
... identifier 0..1AccessionIdentifierAccessionIdentifier
... identifier 0..1FillerOrderNumberFillerOrderNumber
... identifier 0..1PlacerOrderNumberPlacerOrderNumber
... status ?!S1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category S1..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/observation-category","code":"laboratory","userSelected":false}]}
... code S1..1CodeableConceptLab Test Name
Binding: LOINC Codes (extensible)
.... 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..1CodingPlatelets [#/​volume] in Blood by Automated count
..... 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: 777-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 S1..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] SI0..1dateTime, PeriodClinically relevant time/time-period for observation
arg-1: Datetime must be at least to day.
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference(shr-core-Practitioner | shr-core-Organization)Who is responsible for the observation
... valueQuantity 1..1QuantityWithRequiredUnitsActual result
Binding: EquivalentUnitsVS-thousand-per-uL (required)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: QuantitativeResultInterpretationVS (extensible)
... comments 0..1stringComments about result
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(shr-core-Specimen)Specimen used for this observation
... device 0..1Reference(shr-core-Device)(Measurement) Device
... referenceRange I0..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... meaning 0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: Observation Reference Range Meaning Codes (extensible)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation

doco Documentation for this format

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Mapping Source

This structure represents the following mapping definition:

shr.lab.PlateletsNCncPtBldQnAutoCntLabObs maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-observationresults:
  _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 (slice on = type.coding.code; slice strategy = includes)
  ObservationSubjectOfRecord maps to subject
  PractitionerOrOrganizationPerformer maps to performer (slice on = target.reference.resolve(); slice on type = profile; slice strategy = includes)
  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
  Specimen maps to specimen

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation shr-lab-PlateletsNCncPtBldQnAutoCntLabObs
... identifier Slice: Unordered, Open by value:type.coding.code
... identifier 0..1AccessionIdentifierAccessionIdentifier
... identifier 0..1FillerOrderNumberFillerOrderNumber
... identifier 0..1PlacerOrderNumberPlacerOrderNumber
... code
.... coding Slice: Unordered, Open by value:code
.... coding Σ1..1CodingPlatelets [#/​volume] in Blood by Automated count
..... system Fixed Value: http://loinc.org
..... code Fixed Value: 777-3
... subject Reference(shr-core-Patient)
... encounter Reference(shr-core-Encounter)
... performer Reference(shr-core-Practitioner | shr-core-Organization)
... valueQuantity QuantityWithRequiredUnitsBinding: EquivalentUnitsVS-thousand-per-uL (required)
... dataAbsentReason 0..0
... interpretation Binding: QuantitativeResultInterpretationVS (extensible)
... bodySite 0..0
... specimen Reference(shr-core-Specimen)
... device Reference(shr-core-Device)
... referenceRange 0..1
.... meaning Binding: Observation Reference Range Meaning Codes (extensible)
... related 0..0
... component 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*shr-lab-PlateletsNCncPtBldQnAutoCntLabObs
obs-6: SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
arg-2: If there is no component or related element then either a value[x] or a data absent reason must be present
... 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 IdentifierUnique Id for this particular observation
Slice: Unordered, Open by value:type.coding.code
... identifier 0..1AccessionIdentifierAccessionIdentifier
... identifier 0..1FillerOrderNumberFillerOrderNumber
... identifier 0..1PlacerOrderNumberPlacerOrderNumber
... status ?!S1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category S1..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/observation-category","code":"laboratory","userSelected":false}]}
... code S1..1CodeableConceptLab Test Name
Binding: LOINC Codes (extensible)
.... 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..1CodingPlatelets [#/​volume] in Blood by Automated count
..... 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: 777-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 S1..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] SI0..1dateTime, PeriodClinically relevant time/time-period for observation
arg-1: Datetime must be at least to day.
... issued Σ0..1instantDate/Time this was made available
... performer Σ0..*Reference(shr-core-Practitioner | shr-core-Organization)Who is responsible for the observation
... valueQuantity 1..1QuantityWithRequiredUnitsActual result
Binding: EquivalentUnitsVS-thousand-per-uL (required)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: QuantitativeResultInterpretationVS (extensible)
... comments 0..1stringComments about result
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(shr-core-Specimen)Specimen used for this observation
... device 0..1Reference(shr-core-Device)(Measurement) Device
... referenceRange I0..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... meaning 0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: Observation Reference Range Meaning Codes (extensible)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation

doco Documentation for this format

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

 

Terminology Bindings

PathConformanceValueSet / Code
Observation.statusrequiredObservationStatus
Observation.categoryexamplePattern: laboratory
Observation.codeextensibleLOINC Codes

 

Constraints

IdPathDetailsRequirements
obs-6ObservationSHALL only be present if Observation.value[x] is not present
:
obs-7ObservationComponent code SHALL not be same as observation code
:
arg-2ObservationIf there is no component or related element then either a value[x] or a data absent reason must be present
: (component.empty() and related.empty()) implies (dataAbsentReason or value)
arg-1Observation.effective[x]Datetime must be at least to day.
: length() >= 8
obs-3Observation.referenceRangeMust have at least a low or a high or text
: