JohnMoehrke PHR FHIR API
0.5.2 - ci-build United States of America flag

JohnMoehrke PHR FHIR API, published by John Moehrke (himself). This guide is not an authorized publication; it is the continuous build for version 0.5.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/JohnMoehrke/phr/ and changes regularly. See the Directory of published versions

Resource Profile: VA MHV PHR CH labTest.chemistryResults

Official URL: http://johnmoehrke.github.io/phr/StructureDefinition/JFM.PHR.chTest Version: 0.5.2
Standards status: Trial-use Maturity Level: 4 Computable Name: JFMchTest

A profile showing how HDR labTests.chemistryResults will be exposed using FHIR API to johnmoehrke.phr PHR.

One Observation holds one labTests.chemistryResults

  • This profile is based on US-Core Lab
    • category must have http://terminology.hl7.org/CodeSystem/observation-category#laboratory
  • .subject must be the patient from the DiagnosticReport
  • valueInterpretation -> .interpretation
  • testIdentifier -> .code – where LN is Loinc
  • referenceRange -> .referenceRange.text – dont try to break out further as there is little use of this value
  • labCommentEvents -> .note.text
  • value[x] either String or Quantity with units
  • observationValue -> .valueQuantity.value
  • observationUnits.unit -> .valueQuantity.unit
  • observationUnits.code -> .valueQuantity.code - likely need to adjust some
  • observationUnits.codingSystem -> .valueQuantity.system
  • performingOrganization -> .performer
  • labCommentEvents -> '.note`
  • effective[x] is same as the DiagnosticReport
  • issued is same as the DiagnosticReport
  • specimen = specimen
  • basedOn = ServiceRequest
  • ObservationStatus' -> [concept map translation](ConceptMap-VF-ChemistryResult-ObservationStatus.html) -> .status`

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* USCoreLaboratoryResultObservationProfile Measurements and simple assertions
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... basedOn SΣ 1..1 Reference(VA MHV PHR CH labTests.orderedTestCode) Fulfills plan, proposal or order
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code observationStatus
Binding: ObservationStatus (required)
ele-1: All FHIR elements must have a @value or children
... Slices for category S 1..* CodeableConcept `laboratory`
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


ele-1: All FHIR elements must have a @value or children
.... category:Laboratory S 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
... code SΣ 1..1 CodeableConcept testIdentifier
Binding: LOINCCodes (extensible): LOINC codes


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 0..* Coding testIdentifier.code
ele-1: All FHIR elements must have a @value or children
.... text Σ 0..1 string testIdentifier.displayText
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
ele-1: All FHIR elements must have a @value or children
... Slices for effective[x] SΣC 0..1 Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
us-core-1: Datetime must be at least to day.
.... effectiveDateTime dateTime
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime Clinically relevant time/time-period for observation
ele-1: All FHIR elements must have a @value or children
us-core-1: Datetime must be at least to day.
... issued SΣ 0..1 instant Date/Time this version was made available
ele-1: All FHIR elements must have a @value or children
... performer SΣ 0..* Reference(VA MHV PHR Organization) performingOrganization
ele-1: All FHIR elements must have a @value or children
... Slices for value[x] SΣC 0..1 observationValue
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
.... valueQuantity Quantity
.... valueString string
.... value[x]:valueQuantity SΣC 0..1 Quantity Result Value
ele-1: All FHIR elements must have a @value or children
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
.... value[x]:valueString SΣC 0..1 string Result Value
ele-1: All FHIR elements must have a @value or children
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
... interpretation S 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 0..* Coding `.L`, `LL`, `H`, `HH`, or `A`
ele-1: All FHIR elements must have a @value or children
..... system Σ 0..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
..... code Σ 0..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
.... text SΣ 0..1 string valueInterpreation
ele-1: All FHIR elements must have a @value or children
... note S 0..* Annotation labCommentEvents
ele-1: All FHIR elements must have a @value or children
... specimen S 0..1 Reference(VA MHV PHR HDR CH Specimen) Specimen used for this observation
ele-1: All FHIR elements must have a @value or children
... referenceRange SC 0..* BackboneElement Provides guide for interpretation
ele-1: All FHIR elements must have a @value or children
obs-3: Must have at least a low or a high or text
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... text S 0..1 string Text based reference range in an observation
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:LaboratorypreferredPattern: laboratory
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeextensibleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard

This structure is derived from USCoreLaboratoryResultObservationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* USCoreLaboratoryResultObservationProfile Measurements and simple assertions
... identifier 0..0
... basedOn S 1..1 Reference(VA MHV PHR CH labTests.orderedTestCode) Fulfills plan, proposal or order
... partOf 0..0
... status 1..1 code observationStatus
... category 1..* CodeableConcept `laboratory`
... code 1..1 CodeableConcept testIdentifier
.... coding S 0..* Coding testIdentifier.code
.... text 0..1 string testIdentifier.displayText
... subject 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
... focus 0..0
... encounter 0..0
... Slices for effective[x] 0..1 dateTime, Period, Timing, instant Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 0..1 dateTime S Clinically relevant time/time-period for observation
... issued S 0..1 instant Date/Time this version was made available
... performer S 0..* Reference(VA MHV PHR Organization) performingOrganization
... Slices for value[x] 0..1 observationValue
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueString string
.... value[x]:valueQuantity 0..1 Quantity Result Value
.... value[x]:valueString 0..1 string Result Value
... dataAbsentReason 0..0
... interpretation S 0..* CodeableConcept High, low, normal, etc.
.... coding S 0..* Coding `.L`, `LL`, `H`, `HH`, or `A`
..... system 0..1 uri Identity of the terminology system
..... code 0..1 code Symbol in syntax defined by the system
.... text S 0..1 string valueInterpreation
... note S 0..* Annotation labCommentEvents
... bodySite 0..0
... method 0..0
... specimen S 0..1 Reference(VA MHV PHR HDR CH Specimen) Specimen used for this observation
... device 0..0
... referenceRange S 0..* BackboneElement Provides guide for interpretation
.... low 0..0
.... high 0..0
.... type 0..0
.... appliesTo 0..0
.... age 0..0
.... text S 0..1 string Text based reference range in an observation
... hasMember 0..0
... derivedFrom 0..0
... component 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* USCoreLaboratoryResultObservationProfile Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... basedOn SΣ 1..1 Reference(VA MHV PHR CH labTests.orderedTestCode) Fulfills plan, proposal or order
... status ?!SΣ 1..1 code observationStatus
Binding: ObservationStatus (required)
... Slices for category S 1..* CodeableConcept `laboratory`
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:Laboratory S 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
...... 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
... code SΣ 1..1 CodeableConcept testIdentifier
Binding: LOINCCodes (extensible): LOINC codes

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding testIdentifier.code
.... text Σ 0..1 string testIdentifier.displayText
... subject SΣ 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
... Slices for effective[x] SΣC 0..1 Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
us-core-1: Datetime must be at least to day.
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime S Clinically relevant time/time-period for observation
us-core-1: Datetime must be at least to day.
... issued SΣ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(VA MHV PHR Organization) performingOrganization
... Slices for value[x] SΣC 0..1 observationValue
Slice: Unordered, Closed by type:$this
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
.... valueQuantity Quantity S
.... valueString string S
.... value[x]:valueQuantity SΣC 0..1 Quantity S Result Value
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
.... value[x]:valueString SΣC 0..1 string S Result Value
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
... interpretation S 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding `.L`, `LL`, `H`, `HH`, or `A`
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string valueInterpreation
... note S 0..* Annotation labCommentEvents
... specimen S 0..1 Reference(VA MHV PHR HDR CH Specimen) Specimen used for this observation
... referenceRange SC 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text S 0..1 string Text based reference range in an observation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:LaboratorypreferredPattern: laboratory
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeextensibleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

This structure is derived from USCoreLaboratoryResultObservationProfile

Summary

Mandatory: 1 element
Must-Support: 12 elements
Prohibited: 16 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.effective[x]
  • The element 1 is sliced based on the value of Observation.value[x]

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* USCoreLaboratoryResultObservationProfile Measurements and simple assertions
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... basedOn SΣ 1..1 Reference(VA MHV PHR CH labTests.orderedTestCode) Fulfills plan, proposal or order
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code observationStatus
Binding: ObservationStatus (required)
ele-1: All FHIR elements must have a @value or children
... Slices for category S 1..* CodeableConcept `laboratory`
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


ele-1: All FHIR elements must have a @value or children
.... category:Laboratory S 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
... code SΣ 1..1 CodeableConcept testIdentifier
Binding: LOINCCodes (extensible): LOINC codes


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 0..* Coding testIdentifier.code
ele-1: All FHIR elements must have a @value or children
.... text Σ 0..1 string testIdentifier.displayText
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
ele-1: All FHIR elements must have a @value or children
... Slices for effective[x] SΣC 0..1 Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
us-core-1: Datetime must be at least to day.
.... effectiveDateTime dateTime
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime Clinically relevant time/time-period for observation
ele-1: All FHIR elements must have a @value or children
us-core-1: Datetime must be at least to day.
... issued SΣ 0..1 instant Date/Time this version was made available
ele-1: All FHIR elements must have a @value or children
... performer SΣ 0..* Reference(VA MHV PHR Organization) performingOrganization
ele-1: All FHIR elements must have a @value or children
... Slices for value[x] SΣC 0..1 observationValue
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
.... valueQuantity Quantity
.... valueString string
.... value[x]:valueQuantity SΣC 0..1 Quantity Result Value
ele-1: All FHIR elements must have a @value or children
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
.... value[x]:valueString SΣC 0..1 string Result Value
ele-1: All FHIR elements must have a @value or children
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
... interpretation S 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 0..* Coding `.L`, `LL`, `H`, `HH`, or `A`
ele-1: All FHIR elements must have a @value or children
..... system Σ 0..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
..... code Σ 0..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
.... text SΣ 0..1 string valueInterpreation
ele-1: All FHIR elements must have a @value or children
... note S 0..* Annotation labCommentEvents
ele-1: All FHIR elements must have a @value or children
... specimen S 0..1 Reference(VA MHV PHR HDR CH Specimen) Specimen used for this observation
ele-1: All FHIR elements must have a @value or children
... referenceRange SC 0..* BackboneElement Provides guide for interpretation
ele-1: All FHIR elements must have a @value or children
obs-3: Must have at least a low or a high or text
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... text S 0..1 string Text based reference range in an observation
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:LaboratorypreferredPattern: laboratory
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeextensibleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard

Differential View

This structure is derived from USCoreLaboratoryResultObservationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* USCoreLaboratoryResultObservationProfile Measurements and simple assertions
... identifier 0..0
... basedOn S 1..1 Reference(VA MHV PHR CH labTests.orderedTestCode) Fulfills plan, proposal or order
... partOf 0..0
... status 1..1 code observationStatus
... category 1..* CodeableConcept `laboratory`
... code 1..1 CodeableConcept testIdentifier
.... coding S 0..* Coding testIdentifier.code
.... text 0..1 string testIdentifier.displayText
... subject 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
... focus 0..0
... encounter 0..0
... Slices for effective[x] 0..1 dateTime, Period, Timing, instant Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
.... effective[x]:effectiveDateTime S 0..1 dateTime S Clinically relevant time/time-period for observation
... issued S 0..1 instant Date/Time this version was made available
... performer S 0..* Reference(VA MHV PHR Organization) performingOrganization
... Slices for value[x] 0..1 observationValue
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueString string
.... value[x]:valueQuantity 0..1 Quantity Result Value
.... value[x]:valueString 0..1 string Result Value
... dataAbsentReason 0..0
... interpretation S 0..* CodeableConcept High, low, normal, etc.
.... coding S 0..* Coding `.L`, `LL`, `H`, `HH`, or `A`
..... system 0..1 uri Identity of the terminology system
..... code 0..1 code Symbol in syntax defined by the system
.... text S 0..1 string valueInterpreation
... note S 0..* Annotation labCommentEvents
... bodySite 0..0
... method 0..0
... specimen S 0..1 Reference(VA MHV PHR HDR CH Specimen) Specimen used for this observation
... device 0..0
... referenceRange S 0..* BackboneElement Provides guide for interpretation
.... low 0..0
.... high 0..0
.... type 0..0
.... appliesTo 0..0
.... age 0..0
.... text S 0..1 string Text based reference range in an observation
... hasMember 0..0
... derivedFrom 0..0
... component 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C 0..* USCoreLaboratoryResultObservationProfile Measurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
us-core-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present
... 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: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... basedOn SΣ 1..1 Reference(VA MHV PHR CH labTests.orderedTestCode) Fulfills plan, proposal or order
... status ?!SΣ 1..1 code observationStatus
Binding: ObservationStatus (required)
... Slices for category S 1..* CodeableConcept `laboratory`
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:Laboratory S 1..1 CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: laboratory
...... 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
... code SΣ 1..1 CodeableConcept testIdentifier
Binding: LOINCCodes (extensible): LOINC codes

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding testIdentifier.code
.... text Σ 0..1 string testIdentifier.displayText
... subject SΣ 1..1 Reference(US Core Patient Profile) Who and/or what the observation is about
... Slices for effective[x] SΣC 0..1 Clinically relevant time/time-period for observation
Slice: Unordered, Open by type:$this
us-core-1: Datetime must be at least to day.
.... effectiveDateTime dateTime S
.... effectivePeriod Period
.... effectiveTiming Timing
.... effectiveInstant instant
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime S Clinically relevant time/time-period for observation
us-core-1: Datetime must be at least to day.
... issued SΣ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(VA MHV PHR Organization) performingOrganization
... Slices for value[x] SΣC 0..1 observationValue
Slice: Unordered, Closed by type:$this
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
.... valueQuantity Quantity S
.... valueString string S
.... value[x]:valueQuantity SΣC 0..1 Quantity S Result Value
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
.... value[x]:valueString SΣC 0..1 string S Result Value
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
... interpretation S 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding `.L`, `LL`, `H`, `HH`, or `A`
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string valueInterpreation
... note S 0..* Annotation labCommentEvents
... specimen S 0..1 Reference(VA MHV PHR HDR CH Specimen) Specimen used for this observation
... referenceRange SC 0..* BackboneElement Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... text S 0..1 string Text based reference range in an observation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:LaboratorypreferredPattern: laboratory
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.codeextensibleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

This structure is derived from USCoreLaboratoryResultObservationProfile

Summary

Mandatory: 1 element
Must-Support: 12 elements
Prohibited: 16 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.effective[x]
  • The element 1 is sliced based on the value of Observation.value[x]

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron