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 CH labTests.orderedTestCode

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

A profile showing how HDR labTests.orderedTestCode (Order) using FHIR API to MyHealtheVet PHR.

One ServiceRequest holds one labTests.orderedTestCode. Where multiple orderedTestCode elements exist, multiple ServiceRequest are used.

  • .subject must be the patient from the DiagnosticReport
  • code = {labTests.orderedTestCode}
  • status = unknown
  • intent = order
  • category = SCT#108252007 Laboratory procedure
  • specimen = specimen
  • not populating US-Core must support as we dont have the values
    • occurrence[x], authoredOn
  • requester is the requesting provider
  • facility is the requesting facility
  • no other elements are populated

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreServiceRequestProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..* USCoreServiceRequestProfile A request for a service to be performed
... identifier 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..0
... replaces 0..0
... requisition 0..0
... status 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required Pattern: unknown
... intent 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... category 1..* CodeableConcept Classification of service
... priority 0..0
... doNotPerform 0..0
... code 1..1 CodeableConcept labTests.orderedTestCode
.... coding S 0..* Coding code and alternateCode
.... text 0..1 string displayText
... orderDetail 0..0
... quantity[x] 0..0
... subject 1..1 Reference(US Core Patient Profile) Individual or Entity the service is ordered for
... encounter 0..0
... occurrence[x] 0..0
... asNeeded[x] 0..0
... authoredOn 0..0
... requester 0..1 Reference(US Core Practitioner Profile) labTestPromises.labTestRequest.author
... performerType 0..0
... performer 0..* Reference(VA MHV PHR Organization) labTestPromises.labTestRequest.orderingFacilityIdentifier
... locationCode 0..0
... locationReference 0..0
... reasonCode 0..0
... reasonReference 0..0
... insurance 0..0
... supportingInfo 0..0
... specimen 0..0
... bodySite 0..0
... patientInstruction 0..0
... relevantHistory 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* USCoreServiceRequestProfile A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.


Required Pattern: unknown
... intent ?!SΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.


Required Pattern: order
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:us-core SΣ 0..* CodeableConcept Classification of service
Binding: US Core ServiceRequest Category Codes (required)
... code SΣ 1..1 CodeableConcept labTests.orderedTestCode
Binding: US Core Procedure Codes (extensible)
.... coding SΣ 0..* Coding code and alternateCode
.... text Σ 0..1 string displayText
... subject SΣ 1..1 Reference(US Core Patient Profile) Individual or Entity the service is ordered for
... requester SΣ 0..1 Reference(US Core Practitioner Profile) labTestPromises.labTestRequest.author
... performer Σ 0..* Reference(VA MHV PHR Organization) labTestPromises.labTestRequest.orderingFacilityIdentifier

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.statusrequiredPattern: unknown
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category
ServiceRequest.codeextensibleUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* USCoreServiceRequestProfile A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is 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
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.


Required Pattern: unknown
... intent ?!SΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.


Required Pattern: order
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:us-core SΣ 0..* CodeableConcept Classification of service
Binding: US Core ServiceRequest Category Codes (required)
... code SΣ 1..1 CodeableConcept labTests.orderedTestCode
Binding: US Core Procedure Codes (extensible)
.... 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 code and alternateCode
.... text Σ 0..1 string displayText
... subject SΣ 1..1 Reference(US Core Patient Profile) Individual or Entity the service is ordered for
... requester SΣ 0..1 Reference(US Core Practitioner Profile S) labTestPromises.labTestRequest.author
... performer Σ 0..* Reference(VA MHV PHR Organization) labTestPromises.labTestRequest.orderingFacilityIdentifier
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.statusrequiredPattern: unknown
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category
ServiceRequest.codeextensibleUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code

Differential View

This structure is derived from USCoreServiceRequestProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..* USCoreServiceRequestProfile A request for a service to be performed
... identifier 0..0
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..0
... replaces 0..0
... requisition 0..0
... status 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Required Pattern: unknown
... intent 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... category 1..* CodeableConcept Classification of service
... priority 0..0
... doNotPerform 0..0
... code 1..1 CodeableConcept labTests.orderedTestCode
.... coding S 0..* Coding code and alternateCode
.... text 0..1 string displayText
... orderDetail 0..0
... quantity[x] 0..0
... subject 1..1 Reference(US Core Patient Profile) Individual or Entity the service is ordered for
... encounter 0..0
... occurrence[x] 0..0
... asNeeded[x] 0..0
... authoredOn 0..0
... requester 0..1 Reference(US Core Practitioner Profile) labTestPromises.labTestRequest.author
... performerType 0..0
... performer 0..* Reference(VA MHV PHR Organization) labTestPromises.labTestRequest.orderingFacilityIdentifier
... locationCode 0..0
... locationReference 0..0
... reasonCode 0..0
... reasonReference 0..0
... insurance 0..0
... supportingInfo 0..0
... specimen 0..0
... bodySite 0..0
... patientInstruction 0..0
... relevantHistory 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* USCoreServiceRequestProfile A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.


Required Pattern: unknown
... intent ?!SΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.


Required Pattern: order
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:us-core SΣ 0..* CodeableConcept Classification of service
Binding: US Core ServiceRequest Category Codes (required)
... code SΣ 1..1 CodeableConcept labTests.orderedTestCode
Binding: US Core Procedure Codes (extensible)
.... coding SΣ 0..* Coding code and alternateCode
.... text Σ 0..1 string displayText
... subject SΣ 1..1 Reference(US Core Patient Profile) Individual or Entity the service is ordered for
... requester SΣ 0..1 Reference(US Core Practitioner Profile) labTestPromises.labTestRequest.author
... performer Σ 0..* Reference(VA MHV PHR Organization) labTestPromises.labTestRequest.orderingFacilityIdentifier

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.statusrequiredPattern: unknown
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category
ServiceRequest.codeextensibleUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* USCoreServiceRequestProfile A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is 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
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.


Required Pattern: unknown
... intent ?!SΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.


Required Pattern: order
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:us-core SΣ 0..* CodeableConcept Classification of service
Binding: US Core ServiceRequest Category Codes (required)
... code SΣ 1..1 CodeableConcept labTests.orderedTestCode
Binding: US Core Procedure Codes (extensible)
.... 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 code and alternateCode
.... text Σ 0..1 string displayText
... subject SΣ 1..1 Reference(US Core Patient Profile) Individual or Entity the service is ordered for
... requester SΣ 0..1 Reference(US Core Practitioner Profile S) labTestPromises.labTestRequest.author
... performer Σ 0..* Reference(VA MHV PHR Organization) labTestPromises.labTestRequest.orderingFacilityIdentifier
... note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.statusrequiredPattern: unknown
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category
ServiceRequest.codeextensibleUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code

 

Other representations of profile: CSV, Excel, Schematron