MyHealtheVet PHR FHIR API
0.3.9-current - ci-build United States of America flag

MyHealtheVet PHR FHIR API, published by VA Digital Services. This guide is not an authorized publication; it is the continuous build for version 0.3.9-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/department-of-veterans-affairs/mhv-fhir-phr-mapping/ and changes regularly. See the Directory of published versions

Resource Profile: VA MHV PHR labTest

Official URL: https://department-of-veterans-affairs.github.io/mhv-fhir-phr-mapping/StructureDefinition/VA.MHV.PHR.labTest Version: 0.3.9-current
Standards status: Trial-use Maturity Level: 1 Computable Name: MHVlabTest

A profile showing how Microbiology and Pathology LabTestTO and LabResultTO will be exposed using FHIR API to MyHealtheVet PHR.

  • This profile is based on US-Core Lab Observation

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreLaboratoryResultObservationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* USCoreLaboratoryResultObservationProfile Measurements and simple assertions
... Slices for identifier 1..* Identifier Business Identifier for observation
Slice: Unordered, Open by pattern:use
.... identifier:TOid 1..1 Identifier Business Identifier for observation
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `LabTestTO` | `.` | {LabTestTO.id}
... basedOn 0..0
... partOf 0..0
... status 1..1 code registered | preliminary | final | amended +
... category 1..* CodeableConcept Classification of type of observation
... code
.... coding S 0..1 Coding LabTestTO.loinc
.... text S 1..1 string LabTestTO.name
... 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 0..* Reference(VA MHV PHR Organization) Who is responsible for the observation
... Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Result Value
Slice: Unordered, Open by type:$this
.... value[x]:valueString S 0..1 string S Result Value
... dataAbsentReason 0..0
... interpretation 0..0
... note 0..0
... bodySite 0..0
... method 0..0
... specimen S 0..1 Reference(VA MHV PHR Lab Specimen) Specimen used for this observation
... device 0..0
... referenceRange 0..0
... hasMember 0..0
... derivedFrom 0..0
... component 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorObservation.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')
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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier Business Identifier for observation
Slice: Unordered, Open by pattern:use
.... identifier:TOid Σ 1..1 Identifier Business Identifier for observation
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `LabTestTO` | `.` | {LabTestTO.id}
Example General: 123456
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required)
... Slices for category S 1..* CodeableConcept Classification of type of observation
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
..... 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 Laboratory Test Name
Binding: LOINCCodes (extensible): LOINC codes

.... coding SΣ 0..1 Coding LabTestTO.loinc
.... text SΣ 1..1 string LabTestTO.name
... 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
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime 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 Σ 0..* Reference(VA MHV PHR Organization) Who is responsible for the observation
... Slices for value[x] SΣC 0..1 Result Value
Slice: Unordered, Open 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
.... valueCodeableConcept CodeableConcept
.... valueString string
.... value[x]:valueString SΣC 0..1 string Result Value
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
... specimen S 0..1 Reference(VA MHV PHR Lab Specimen) Specimen used for this observation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
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.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorObservation.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')
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
... Slices for identifier Σ 1..* Identifier Business Identifier for observation
Slice: Unordered, Open by pattern:use
.... identifier:TOid Σ 1..1 Identifier Business Identifier for observation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `LabTestTO` | `.` | {LabTestTO.id}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required)
... Slices for category S 1..* CodeableConcept Classification of type of observation
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 Laboratory Test Name
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..1 Coding LabTestTO.loinc
.... text SΣ 1..1 string LabTestTO.name
... 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 Σ 0..* Reference(VA MHV PHR Organization) Who is responsible for the observation
... Slices for value[x] SΣC 0..1 Result Value
Slice: Unordered, Open 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
.... valueCodeableConcept CodeableConcept S
.... valueString string S
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... 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.
... specimen S 0..1 Reference(VA MHV PHR Lab Specimen) Specimen used for this observation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Observation.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
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.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
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

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorObservation.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreLaboratoryResultObservationProfile

Summary

Mandatory: 4 elements
Must-Support: 6 elements
Prohibited: 14 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.identifier
  • 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: 1

Differential View

This structure is derived from USCoreLaboratoryResultObservationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..* USCoreLaboratoryResultObservationProfile Measurements and simple assertions
... Slices for identifier 1..* Identifier Business Identifier for observation
Slice: Unordered, Open by pattern:use
.... identifier:TOid 1..1 Identifier Business Identifier for observation
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `LabTestTO` | `.` | {LabTestTO.id}
... basedOn 0..0
... partOf 0..0
... status 1..1 code registered | preliminary | final | amended +
... category 1..* CodeableConcept Classification of type of observation
... code
.... coding S 0..1 Coding LabTestTO.loinc
.... text S 1..1 string LabTestTO.name
... 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 0..* Reference(VA MHV PHR Organization) Who is responsible for the observation
... Slices for value[x] 0..1 Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, Period Result Value
Slice: Unordered, Open by type:$this
.... value[x]:valueString S 0..1 string S Result Value
... dataAbsentReason 0..0
... interpretation 0..0
... note 0..0
... bodySite 0..0
... method 0..0
... specimen S 0..1 Reference(VA MHV PHR Lab Specimen) Specimen used for this observation
... device 0..0
... referenceRange 0..0
... hasMember 0..0
... derivedFrom 0..0
... component 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorObservation.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

Key Elements 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier Business Identifier for observation
Slice: Unordered, Open by pattern:use
.... identifier:TOid Σ 1..1 Identifier Business Identifier for observation
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `LabTestTO` | `.` | {LabTestTO.id}
Example General: 123456
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required)
... Slices for category S 1..* CodeableConcept Classification of type of observation
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
..... 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 Laboratory Test Name
Binding: LOINCCodes (extensible): LOINC codes

.... coding SΣ 0..1 Coding LabTestTO.loinc
.... text SΣ 1..1 string LabTestTO.name
... 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
.... effective[x]:effectiveDateTime SΣC 0..1 dateTime 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 Σ 0..* Reference(VA MHV PHR Organization) Who is responsible for the observation
... Slices for value[x] SΣC 0..1 Result Value
Slice: Unordered, Open 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
.... valueCodeableConcept CodeableConcept
.... valueString string
.... value[x]:valueString SΣC 0..1 string Result Value
us-core-4: SHOULD use Snomed CT for coded Results
us-core-3: SHALL use UCUM for coded quantity units.
... specimen S 0..1 Reference(VA MHV PHR Lab Specimen) Specimen used for this observation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
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.component.codeexampleLOINCCodes (a valid code from LOINC)
http://hl7.org/fhir/ValueSet/observation-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorObservation.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

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
... Slices for identifier Σ 1..* Identifier Business Identifier for observation
Slice: Unordered, Open by pattern:use
.... identifier:TOid Σ 1..1 Identifier Business Identifier for observation
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `LabTestTO` | `.` | {LabTestTO.id}
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus (required)
... Slices for category S 1..* CodeableConcept Classification of type of observation
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 Laboratory Test Name
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..1 Coding LabTestTO.loinc
.... text SΣ 1..1 string LabTestTO.name
... 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 Σ 0..* Reference(VA MHV PHR Organization) Who is responsible for the observation
... Slices for value[x] SΣC 0..1 Result Value
Slice: Unordered, Open 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
.... valueCodeableConcept CodeableConcept S
.... valueString string S
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... 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.
... specimen S 0..1 Reference(VA MHV PHR Lab Specimen) Specimen used for this observation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Observation.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
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.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
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

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorObservation.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreLaboratoryResultObservationProfile

Summary

Mandatory: 4 elements
Must-Support: 6 elements
Prohibited: 14 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.identifier
  • 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: 1

 

Other representations of profile: CSV, Excel, Schematron