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 Location

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

A profile on the Location resource for MHV PHR exposing Location using FHIR API.

  • based on US-Core for Location
  • identifier
    • system = urn:oid:2.16.840.1.113883.4.349
  • name is the name as known
  • always a contained resource, so not exposed RESTfully

NOT USING Mapping to VIA HospitalLocationTO.

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocation Details and position information for a physical place
... Slices for identifier 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:use
.... identifier:TOid 1..1 Identifier Unique code or number identifying the location to its users
..... 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 `HospitalLocationTO` | `.` | {HospitalLocationTO.id}
... status 0..0
... operationalStatus 0..0
... name 1..1 string Name of the location as used by humans
... alias 0..0
... description 0..0
... mode 0..0
... type 0..0
... telecom 0..0
... address 0..0
... physicalType 0..0
... position 0..0
... managingOrganization 0..0
... partOf 0..0
... hoursOfOperation 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorLocation.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
.. Location 0..* USCoreLocation Details and position information for a physical place
... 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 Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:use
.... identifier:TOid Σ 1..1 Identifier Unique code or number identifying the location to its users
..... 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 `HospitalLocationTO` | `.` | {HospitalLocationTO.id}
Example General: 123456
... name SΣ 1..1 string Name of the location as used by humans

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorLocation.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
.. Location 0..* USCoreLocation Details and position information for a physical place
... 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 Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:use
.... identifier:TOid Σ 1..1 Identifier Unique code or number identifying the location to its users
..... 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 `HospitalLocationTO` | `.` | {HospitalLocationTO.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)
... name SΣ 1..1 string Name of the location as used by humans

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorLocation.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 USCoreLocation

Summary

Mandatory: 3 elements
Prohibited: 15 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Location.identifier

Maturity: 3

Differential View

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocation Details and position information for a physical place
... Slices for identifier 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:use
.... identifier:TOid 1..1 Identifier Unique code or number identifying the location to its users
..... 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 `HospitalLocationTO` | `.` | {HospitalLocationTO.id}
... status 0..0
... operationalStatus 0..0
... name 1..1 string Name of the location as used by humans
... alias 0..0
... description 0..0
... mode 0..0
... type 0..0
... telecom 0..0
... address 0..0
... physicalType 0..0
... position 0..0
... managingOrganization 0..0
... partOf 0..0
... hoursOfOperation 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorLocation.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
.. Location 0..* USCoreLocation Details and position information for a physical place
... 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 Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:use
.... identifier:TOid Σ 1..1 Identifier Unique code or number identifying the location to its users
..... 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 `HospitalLocationTO` | `.` | {HospitalLocationTO.id}
Example General: 123456
... name SΣ 1..1 string Name of the location as used by humans

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorLocation.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
.. Location 0..* USCoreLocation Details and position information for a physical place
... 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 Unique code or number identifying the location to its users
Slice: Unordered, Open by pattern:use
.... identifier:TOid Σ 1..1 Identifier Unique code or number identifying the location to its users
..... 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 `HospitalLocationTO` | `.` | {HospitalLocationTO.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)
... name SΣ 1..1 string Name of the location as used by humans

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Location.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorLocation.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 USCoreLocation

Summary

Mandatory: 3 elements
Prohibited: 15 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Location.identifier

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron