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 HDR CH Specimen

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

A profile showing how the labTestPromises.specimen is mapped into a FHIR Specimen.

  • This is usually a contained resource, contained in the Lab Report. The use of contained is for simplicity sake and to limit the need to manage Specimen resource instances
  • must have a type
    • Specimen.type.text <- labTestPromises.specimen.specimenSource
  • should have a collectedDateTime derived from labTestPromises.specimen.specimenTakenDate

Usage:

Formal Views of Profile Content

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

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..* Specimen Sample for analysis
... identifier 0..0
... status 0..1 code available | unavailable | unsatisfactory | entered-in-error
Required Pattern: available
... type S 1..1 CodeableConcept Kind of material that forms the specimen
... subject 0..0
... receivedTime 0..0
... parent 0..0
... request S 1..* Reference(ServiceRequest) Why the specimen was collected
... collection S 0..1 BackboneElement Collection details
.... collector 0..0
.... Slices for collected[x] 0..1 dateTime, Period Collection time
Slice: Unordered, Open by type:$this
..... collected[x]:collectedDateTime S 0..1 dateTime Collection time
.... duration 0..0
.... quantity 0..0
.... method 0..0
.... bodySite 0..0
.... fastingStatus[x] 0..0
... processing 0..0
... container 0..0
... condition 0..0
... note 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..* Specimen Sample for analysis
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.


Required Pattern: available
... type SΣ 1..1 CodeableConcept Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.

... request S 1..* Reference(ServiceRequest) Why the specimen was collected
... collection S 0..1 BackboneElement Collection details
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for collected[x] Σ 0..1 Collection time
Slice: Unordered, Open by type:$this
..... collectedDateTime dateTime
..... collectedPeriod Period
..... collected[x]:collectedDateTime SΣ 0..1 dateTime Collection time

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Specimen.statusrequiredPattern: available
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typeexampleHl7VSSpecimenType
http://terminology.hl7.org/ValueSet/v2-0487
NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..* Specimen Sample for analysis
... 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
... accessionIdentifier Σ 0..1 Identifier Identifier assigned by the lab
... status ?!Σ 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.


Required Pattern: available
... type SΣ 1..1 CodeableConcept Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.

... request S 1..* Reference(ServiceRequest) Why the specimen was collected
... collection S 0..1 BackboneElement Collection details
.... 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
.... Slices for collected[x] Σ 0..1 Collection time
Slice: Unordered, Open by type:$this
..... collectedDateTime dateTime
..... collectedPeriod Period
..... collected[x]:collectedDateTime SΣ 0..1 dateTime Collection time

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Specimen.statusrequiredPattern: available
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typeexampleHl7VSSpecimenType
http://terminology.hl7.org/ValueSet/v2-0487
Specimen.processing.procedureexampleSpecimenProcessingProcedure
http://hl7.org/fhir/ValueSet/specimen-processing-procedure
from the FHIR Standard
Specimen.container.typeexampleSpecimenContainerType
http://hl7.org/fhir/ValueSet/specimen-container-type
from the FHIR Standard
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
http://terminology.hl7.org/ValueSet/v2-0371

This structure is derived from Specimen

Summary

Mandatory: 2 elements
Must-Support: 4 elements
Prohibited: 14 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Specimen.collection.collected[x]

Maturity: 1

Differential View

This structure is derived from Specimen

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..* Specimen Sample for analysis
... identifier 0..0
... status 0..1 code available | unavailable | unsatisfactory | entered-in-error
Required Pattern: available
... type S 1..1 CodeableConcept Kind of material that forms the specimen
... subject 0..0
... receivedTime 0..0
... parent 0..0
... request S 1..* Reference(ServiceRequest) Why the specimen was collected
... collection S 0..1 BackboneElement Collection details
.... collector 0..0
.... Slices for collected[x] 0..1 dateTime, Period Collection time
Slice: Unordered, Open by type:$this
..... collected[x]:collectedDateTime S 0..1 dateTime Collection time
.... duration 0..0
.... quantity 0..0
.... method 0..0
.... bodySite 0..0
.... fastingStatus[x] 0..0
... processing 0..0
... container 0..0
... condition 0..0
... note 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..* Specimen Sample for analysis
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.


Required Pattern: available
... type SΣ 1..1 CodeableConcept Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.

... request S 1..* Reference(ServiceRequest) Why the specimen was collected
... collection S 0..1 BackboneElement Collection details
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for collected[x] Σ 0..1 Collection time
Slice: Unordered, Open by type:$this
..... collectedDateTime dateTime
..... collectedPeriod Period
..... collected[x]:collectedDateTime SΣ 0..1 dateTime Collection time

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Specimen.statusrequiredPattern: available
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typeexampleHl7VSSpecimenType
http://terminology.hl7.org/ValueSet/v2-0487

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Specimen 0..* Specimen Sample for analysis
... 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
... accessionIdentifier Σ 0..1 Identifier Identifier assigned by the lab
... status ?!Σ 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.


Required Pattern: available
... type SΣ 1..1 CodeableConcept Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.

... request S 1..* Reference(ServiceRequest) Why the specimen was collected
... collection S 0..1 BackboneElement Collection details
.... 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
.... Slices for collected[x] Σ 0..1 Collection time
Slice: Unordered, Open by type:$this
..... collectedDateTime dateTime
..... collectedPeriod Period
..... collected[x]:collectedDateTime SΣ 0..1 dateTime Collection time

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Specimen.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Specimen.statusrequiredPattern: available
http://hl7.org/fhir/ValueSet/specimen-status|4.0.1
from the FHIR Standard
Specimen.typeexampleHl7VSSpecimenType
http://terminology.hl7.org/ValueSet/v2-0487
Specimen.processing.procedureexampleSpecimenProcessingProcedure
http://hl7.org/fhir/ValueSet/specimen-processing-procedure
from the FHIR Standard
Specimen.container.typeexampleSpecimenContainerType
http://hl7.org/fhir/ValueSet/specimen-container-type
from the FHIR Standard
Specimen.container.additive[x]exampleHl7VSAdditivePreservative
http://terminology.hl7.org/ValueSet/v2-0371

This structure is derived from Specimen

Summary

Mandatory: 2 elements
Must-Support: 4 elements
Prohibited: 14 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Specimen.collection.collected[x]

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron