Validated Healthcare Directory IG STU1 Draft for Comment

This page is part of the Validated Healthcare Directory FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.2.0. . For a full list of available versions, see the Directory of published versions

1.0 - StructureDefinition: vhdir-location - Content

This profile sets minimum expectations for searching for and fetching information associated with a location. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the location resource when using this profile.

Background & Scope

A location is the physical place where healthcare services are provided, practitioners are employed, organizations are based, etc. Locations can range in scope from a room in a building to a geographic region/area.

This profile removes location.operationalStatus because maintaining bed-level information is out of scope for this implementation guide. It also removes location.mode because maintaining information about kinds of locations (as opposed to actual location instances) is out of scope for this implementation guide.

This profile also adds a number of optional extensions, including extensions for representing a geographic region/area, accessibility options at the location, the EHR product(s) in use at the location, whether the location is accepting new patients, and when the location is available.

Examples:

The following are example uses for the vhdir-location profile:

  • TBD

Mandatory Data Elements

There are no mandatory attributes for the healthcareService resource. However, some attributes have mandatory components if they are included in the resource (including extensions). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

  1. If the location has a defined position, one value representing longitude in location.position.longitude and one value representing latitude in location.position.latitude
  2. If the location has a geographic region/area, one URI to a KML or GeoJSON object defining the region/area in location.boundary.region (extension)
  3. For each accessibility option offered by the location, one type in location.accessibility.type (extension)
  4. For each indication of whether the location is accepting new patients, one boolean value in location.newPatients.acceptingPatients (extension)
  5. For each indication that the location is not available, a description of why the location is unavailable in location.notAvailable.description (extension)

Profile specific implementation guidance:

  • TBD

Extensions:

  1. Restriction (0..*) - indicates restrictions on the use/release of information associated with the location
  2. Boundary (0..*) - indicates a region/area for the location, consisting of:
    1. Region (1..1) - a URI to a KML or GeoJSON object defining the region/area
    2. LocalName (0..*) - a friendly description of the region/area (such as the colloquial name of the region)
  3. Accessibility (0..*) - indicates accessibility options available at the location (e.g. handicap accessibility), consisting of:
    1. Type (1..1) - indicates the type of accessibility option offered at the location
    2. Description (0..1) - additional descriptive information about the accessibility option
  4. EHR (0..*) - provides information about the EHR product(s) used at the location, consisting of:
    1. Developer (0..1) - the developer of the EHR product
    2. Product (0..1) - the name of the EHR product
    3. Version (0..1) - the version of the EHR product
    4. CertificationID (0..1) - a unique ID assigned by the ONC-Authorized Certification Body
    5. CertificationEdition (0..1) - indicates which certification edition the EHR product has been certified to
    6. PatientAccess (0..*) - indicates whether the EHR product provides patient access functions (e.g. a patient portal)
  5. NewPatients (0..*) - indicates whether the location is accepting new patients, consisting of:
    1. AcceptingPatients (1.1) - a value of ‘true’ means the location is accepting new patients, ‘false’ means it is not
    2. Network (0..1) - indicates whether the location is accepting new patients for a particular health provider insurance network
  6. NewPatientProfile (0..1) - a description of the type of patients the location accepts (e.g. pediatric only)
  7. AvailableTime (0..*) - indicates when the location is available, consisting of:
    1. DaysOfWeek (0..*) - indicates the days the location is available
    2. AllDay (0..1) - indicates whether the location is always available
    3. AvailableStartTime (0..1) - indicates when the location opens
    4. AvailableEndTime (0..1) - indicates when the location closes
  8. NotAvailable (0..*) - indicates when the location is not available
    1. Description (1..1) - describes why the location is not available
    2. During (0..1) - indicates a period of time for when the location is not available
  9. AvailabilityExceptions (0..1) - indicates any exceptions to the availablity of the location

Terminology

TBD

1.2 - Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/ig/vhdir/StructureDefinition/vhdir-location

Defines the basic constraints and extensions on the Location resource for use in a Validated Healthcare Directory

This profile builds on Location.

This profile was published on Tue Oct 03 23:49:16 AEDT 2017 as a draft by HL7 International.

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

Complete Summary of the Mandatory Requirements

There are no mandatory attributes for the location resource. However, some attributes have mandatory components if they are included in the resource (including extensions):

  1. If the location has a defined position, one value representing longitude in location.position.longitude and one value representing latitude in location.position.latitude
  2. If the location has a geographic region/area, one URI to a KML or GeoJSON object defining the region/area in location.boundary.region (extension)
  3. For each accessibility option offered by the location, one type in location.accessibility.type (extension)
  4. For each indication of whether the location is accepting new patients, one boolean value in location.newPatients.acceptingPatients (extension)
  5. For each indication that the location is not available, a description of why the location is unavailable in location.notAvailable.description (extension)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*
... language 0..0
... identifier 0..*Identifier
.... identifier-status 0..1codeStatus
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status
... operationalStatus 0..0
... mode 0..0
... telecom 0..*ContactPoint
.... contactPoint-availableTime 0..*(Complex)Available time
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)viaIntermediary
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
... address 0..1Address
.... address-position 0..1(Complex)Position
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position
... managingOrganization 0..1Reference(Organization), Reference(vhdir-organization)
... boundary 0..*(Complex)Boundary
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/boundary
... accessibility 0..*(Complex)Accessibility
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/accessibility
... ehr 0..*(Complex)EHR
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/ehr
... newPatients 0..1(Complex)New patients
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/newPatients
... newPatientProfile 0..*CodeableConceptNew patient profile
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/newPatientProfile
... location-availability 0..*(Complex)Availability
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/location-availability
... usage-restriction 0..*Reference(vhdir-restriction)Restriction
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*Details and position information for a physical place
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... boundary 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/boundary
... accessibility 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/accessibility
... ehr 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/ehr
... newPatients 0..1(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/newPatients
... newPatientProfile 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/newPatientProfile
... location-availability 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/location-availability
... usage-restriction 0..*Reference(vhdir-restriction)Restriction
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
.... id 0..1stringxml:id (or equivalent in JSON)
.... identifier-status 0..1codeExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status"
..... valueCode 0..1codeStatus
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type Σ0..1CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible)
... telecom 0..*ContactPointContact details of the location
.... id 0..1stringxml:id (or equivalent in JSON)
.... contactPoint-availableTime 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionDays of week
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"daysOfWeek"
...... valueCode 0..1codeDays of week
..... extension 0..1ExtensionAll day
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"allDay"
...... valueBoolean 0..1booleanAll day
..... extension 0..1ExtensionAvailable start time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableStartTime"
...... valueTime 0..1timeAvailable start time
..... extension 0..1ExtensionAvailable end time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableEndTime"
...... valueTime 0..1timeAvailable end time
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime"
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary"
..... value[x] 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Via intermediary
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address 0..1AddressPhysical location
.... id 0..1stringxml:id (or equivalent in JSON)
.... address-position 0..1(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 1..1ExtensionLongitude
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"longitude"
...... valueDecimal 0..1decimalLongitude
..... extension 1..1ExtensionLatitude
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"latitude"
...... valueDecimal 0..1decimalLatitude
..... extension 0..1ExtensionAltitude
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"altitude"
...... valueDecimal 0..1decimalAltitude
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position"
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General': 137 Nowhere Street
.... city Σ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General': 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example)
... position I0..1BackboneElementThe absolute geographic location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization Σ0..1Reference(Organization), Reference(vhdir-organization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically part of
... hoursOfOperation I0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Complete Summary of the Mandatory Requirements

There are no mandatory attributes for the location resource. However, some attributes have mandatory components if they are included in the resource (including extensions):

  1. If the location has a defined position, one value representing longitude in location.position.longitude and one value representing latitude in location.position.latitude
  2. If the location has a geographic region/area, one URI to a KML or GeoJSON object defining the region/area in location.boundary.region (extension)
  3. For each accessibility option offered by the location, one type in location.accessibility.type (extension)
  4. For each indication of whether the location is accepting new patients, one boolean value in location.newPatients.acceptingPatients (extension)
  5. For each indication that the location is not available, a description of why the location is unavailable in location.notAvailable.description (extension)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*
... language 0..0
... identifier 0..*Identifier
.... identifier-status 0..1codeStatus
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status
... operationalStatus 0..0
... mode 0..0
... telecom 0..*ContactPoint
.... contactPoint-availableTime 0..*(Complex)Available time
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)viaIntermediary
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
... address 0..1Address
.... address-position 0..1(Complex)Position
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position
... managingOrganization 0..1Reference(Organization), Reference(vhdir-organization)
... boundary 0..*(Complex)Boundary
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/boundary
... accessibility 0..*(Complex)Accessibility
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/accessibility
... ehr 0..*(Complex)EHR
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/ehr
... newPatients 0..1(Complex)New patients
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/newPatients
... newPatientProfile 0..*CodeableConceptNew patient profile
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/newPatientProfile
... location-availability 0..*(Complex)Availability
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/location-availability
... usage-restriction 0..*Reference(vhdir-restriction)Restriction
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location I0..*Details and position information for a physical place
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... boundary 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/boundary
... accessibility 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/accessibility
... ehr 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/ehr
... newPatients 0..1(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/newPatients
... newPatientProfile 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/newPatientProfile
... location-availability 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/location-availability
... usage-restriction 0..*Reference(vhdir-restriction)Restriction
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
.... id 0..1stringxml:id (or equivalent in JSON)
.... identifier-status 0..1codeExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status"
..... valueCode 0..1codeStatus
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... name Σ0..1stringName of the location as used by humans
... alias 0..*stringA list of alternate names that the location is known as, or was known as in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... type Σ0..1CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible)
... telecom 0..*ContactPointContact details of the location
.... id 0..1stringxml:id (or equivalent in JSON)
.... contactPoint-availableTime 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionDays of week
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"daysOfWeek"
...... valueCode 0..1codeDays of week
..... extension 0..1ExtensionAll day
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"allDay"
...... valueBoolean 0..1booleanAll day
..... extension 0..1ExtensionAvailable start time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableStartTime"
...... valueTime 0..1timeAvailable start time
..... extension 0..1ExtensionAvailable end time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableEndTime"
...... valueTime 0..1timeAvailable end time
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime"
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary"
..... value[x] 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Via intermediary
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address 0..1AddressPhysical location
.... id 0..1stringxml:id (or equivalent in JSON)
.... address-position 0..1(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 1..1ExtensionLongitude
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"longitude"
...... valueDecimal 0..1decimalLongitude
..... extension 1..1ExtensionLatitude
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"latitude"
...... valueDecimal 0..1decimalLatitude
..... extension 0..1ExtensionAltitude
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"altitude"
...... valueDecimal 0..1decimalAltitude
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position"
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General': 137 Nowhere Street
.... city Σ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General': 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example)
... position I0..1BackboneElementThe absolute geographic location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization Σ0..1Reference(Organization), Reference(vhdir-organization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically part of
... hoursOfOperation I0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

1.3 - Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.

TBD