FHIR Artifacts > Structure Definition: Location Profile

Structure Definition: Location Profile

Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Location

Simplifier project page: Location

Derived from: Location (R4)

Formal Views of Profile Content

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

Differential View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
GeoJSONS I0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!0..1codeBinding
operationalStatusΣ0..1CodingBinding
nameS Σ0..1string
alias0..*string
descriptionS Σ0..1string
modeΣ0..1codeBinding
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
systemS Σ I0..1codeBinding
valueS Σ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
useS Σ ?!0..1codeBinding
typeS Σ0..1codeBinding
textS Σ0..1string
lineS Σ0..*string
cityS Σ0..1string
districtΣ0..1string
stateS Σ0..1string
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
longitudeS1..1decimal
latitudeS1..1decimal
altitudeS0..1decimal
managingOrganizationΣ I0..1Reference(Organization)
partOfI0..1Reference(Location)
daysOfWeekS0..*codeBinding
allDayS0..1boolean
openingTimeS0..1time
closingTimeS0..1time
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)

Hybrid View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
GeoJSONS I0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!0..1codeBinding
operationalStatusΣ0..1CodingBinding
nameS Σ0..1string
alias0..*string
descriptionS Σ0..1string
modeΣ0..1codeBinding
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
systemS Σ I0..1codeBinding
valueS Σ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
useS Σ ?!0..1codeBinding
typeS Σ0..1codeBinding
textS Σ0..1string
lineS Σ0..*string
cityS Σ0..1string
districtΣ0..1string
stateS Σ0..1string
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
longitudeS1..1decimal
latitudeS1..1decimal
altitudeS0..1decimal
managingOrganizationΣ I0..1Reference(Organization)
partOfI0..1Reference(Location)
daysOfWeekS0..*codeBinding
allDayS0..1boolean
openingTimeS0..1time
closingTimeS0..1time
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)

Snapshot View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
GeoJSONS I0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ0..1uri
valueS Σ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!0..1codeBinding
operationalStatusΣ0..1CodingBinding
nameS Σ0..1string
alias0..*string
descriptionS Σ0..1string
modeΣ0..1codeBinding
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
systemS Σ I0..1codeBinding
valueS Σ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
useS Σ ?!0..1codeBinding
typeS Σ0..1codeBinding
textS Σ0..1string
lineS Σ0..*string
cityS Σ0..1string
districtΣ0..1string
stateS Σ0..1string
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
systemS Σ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
longitudeS1..1decimal
latitudeS1..1decimal
altitudeS0..1decimal
managingOrganizationΣ I0..1Reference(Organization)
partOfI0..1Reference(Location)
daysOfWeekS0..*codeBinding
allDayS0..1boolean
openingTimeS0..1time
closingTimeS0..1time
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)

Table View

Location..
Location.meta1..
Location.meta.profile1..
Location.extension0..
Location.extensionExtension0..1
Location.identifier..
Location.identifier.system..
Location.identifier.value..
Location.status..
Location.name..
Location.description..
Location.mode..
Location.type..
Location.type.coding..
Location.type.coding.system..
Location.type.coding.code..
Location.type.coding.display..
Location.type.text..
Location.telecom..
Location.telecom.system..
Location.telecom.value..
Location.address..
Location.address.use..
Location.address.type..
Location.address.text..
Location.address.line..
Location.address.city..
Location.address.state..
Location.address.postalCode..
Location.address.country..
Location.physicalType..
Location.physicalType.coding..
Location.physicalType.coding.system..
Location.physicalType.coding.code..
Location.physicalType.coding.display..
Location.position..
Location.position.longitude..
Location.position.latitude..
Location.position.altitude..
Location.hoursOfOperation..
Location.hoursOfOperation.daysOfWeek..
Location.hoursOfOperation.allDay..
Location.hoursOfOperation.openingTime..
Location.hoursOfOperation.closingTime..


JSON View

{
    "resourceType": "StructureDefinition",
    "id": "ca-on-eReferral-profile-Location",
    "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Location",
    "version": "1.0.1",
    "name": "EReferralLocation-v11",
    "title": "Location",
    "status": "draft",
    "description": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Location",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Location",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Location.meta",
                "path": "Location.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Location.meta.profile",
                "path": "Location.meta.profile",
                "comment": "#### **_` FOR eREFERRAL USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Location|1.0.1 `_**\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.  The list of profile URLs is a set.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Location.extension",
                "path": "Location.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Location.extension:GeoJSON",
                "path": "Location.extension",
                "sliceName": "GeoJSON",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/geolocation"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Location.identifier",
                "path": "Location.identifier",
                "mustSupport": true
            },
            {
                "id": "Location.identifier.system",
                "path": "Location.identifier.system",
                "mustSupport": true
            },
            {
                "id": "Location.identifier.value",
                "path": "Location.identifier.value",
                "mustSupport": true
            },
            {
                "id": "Location.status",
                "path": "Location.status",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/location-status"
                }
            },
            {
                "id": "Location.name",
                "path": "Location.name",
                "mustSupport": true
            },
            {
                "id": "Location.description",
                "path": "Location.description",
                "mustSupport": true
            },
            {
                "id": "Location.mode",
                "path": "Location.mode",
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/location-mode"
                }
            },
            {
                "id": "Location.type",
                "path": "Location.type",
                "mustSupport": true
            },
            {
                "id": "Location.type.coding",
                "path": "Location.type.coding",
                "mustSupport": true
            },
            {
                "id": "Location.type.coding.system",
                "path": "Location.type.coding.system",
                "mustSupport": true
            },
            {
                "id": "Location.type.coding.code",
                "path": "Location.type.coding.code",
                "mustSupport": true
            },
            {
                "id": "Location.type.coding.display",
                "path": "Location.type.coding.display",
                "mustSupport": true
            },
            {
                "id": "Location.type.text",
                "path": "Location.type.text",
                "mustSupport": true
            },
            {
                "id": "Location.telecom",
                "path": "Location.telecom",
                "mustSupport": true
            },
            {
                "id": "Location.telecom.system",
                "path": "Location.telecom.system",
                "mustSupport": true
            },
            {
                "id": "Location.telecom.value",
                "path": "Location.telecom.value",
                "mustSupport": true
            },
            {
                "id": "Location.address",
                "path": "Location.address",
                "mustSupport": true
            },
            {
                "id": "Location.address.use",
                "path": "Location.address.use",
                "mustSupport": true
            },
            {
                "id": "Location.address.type",
                "path": "Location.address.type",
                "mustSupport": true
            },
            {
                "id": "Location.address.text",
                "path": "Location.address.text",
                "mustSupport": true
            },
            {
                "id": "Location.address.line",
                "path": "Location.address.line",
                "mustSupport": true
            },
            {
                "id": "Location.address.city",
                "path": "Location.address.city",
                "mustSupport": true
            },
            {
                "id": "Location.address.state",
                "path": "Location.address.state",
                "mustSupport": true
            },
            {
                "id": "Location.address.postalCode",
                "path": "Location.address.postalCode",
                "mustSupport": true
            },
            {
                "id": "Location.address.country",
                "path": "Location.address.country",
                "mustSupport": true
            },
            {
                "id": "Location.physicalType",
                "path": "Location.physicalType",
                "mustSupport": true
            },
            {
                "id": "Location.physicalType.coding",
                "path": "Location.physicalType.coding",
                "mustSupport": true
            },
            {
                "id": "Location.physicalType.coding.system",
                "path": "Location.physicalType.coding.system",
                "mustSupport": true
            },
            {
                "id": "Location.physicalType.coding.code",
                "path": "Location.physicalType.coding.code",
                "mustSupport": true
            },
            {
                "id": "Location.physicalType.coding.display",
                "path": "Location.physicalType.coding.display",
                "mustSupport": true
            },
            {
                "id": "Location.position",
                "path": "Location.position",
                "mustSupport": false
            },
            {
                "id": "Location.position.longitude",
                "path": "Location.position.longitude",
                "mustSupport": true
            },
            {
                "id": "Location.position.latitude",
                "path": "Location.position.latitude",
                "mustSupport": true
            },
            {
                "id": "Location.position.altitude",
                "path": "Location.position.altitude",
                "mustSupport": true
            },
            {
                "id": "Location.hoursOfOperation.daysOfWeek",
                "path": "Location.hoursOfOperation.daysOfWeek",
                "mustSupport": true
            },
            {
                "id": "Location.hoursOfOperation.allDay",
                "path": "Location.hoursOfOperation.allDay",
                "mustSupport": true
            },
            {
                "id": "Location.hoursOfOperation.openingTime",
                "path": "Location.hoursOfOperation.openingTime",
                "mustSupport": true
            },
            {
                "id": "Location.hoursOfOperation.closingTime",
                "path": "Location.hoursOfOperation.closingTime",
                "mustSupport": true
            }
        ]
    }
}

Usage

Location includes both incidental locations (a place which is used for healthcare without prior designation or authorization) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages.

Location is used in a variety of ways in an eReferral process:

  • In an eReferral ServiceRequest it is used to represent

    • the Patient's general pracitioner's location
    • the eReferral Requester's location
    • an appointment provider's location
  • In a Provider or HealthcareService Registry, it is used to represent location of the provided service. In this case additional fields become useful, such as physicalType, position, managingOrganization, hoursOfOperation, and availabilityExceptions.

Notes

.id

  • used to uniquely identify the resource
  • if a persistent identity for the resource is not available to use when constructing a message Bundle for transmission via Direct Messaging, a UUID SHOULD be used in this element (with a corresponding value in Bundle.entry.fullUrl)

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Location|1.0.1

extension:GeoJSON

  • HL7 FHIR defined extension used to locate the absolute longitude & latitude of a location

.telecom

  • also included HealthcareService & PractitionerRole
  • Location.telecom value takes precedence when provided