DRAFT - The specification is currently in development and subject to significant change. It is not ready for limited roll-out or production level use.

Location (CA:eReC)

Structure Definition: Location Profile

Canonical URL:https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-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

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
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
descriptionΣ0..1string
modeΣ0..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
systemS Σ I0..1codeBinding
valueS Σ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textS Σ0..1string
lineΣ0..*string
cityS Σ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
physicalTypeΣ0..1CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
longitude1..1decimal
latitude1..1decimal
altitude0..1decimal
managingOrganizationΣ I0..1Reference(Organization)
partOfI0..1Reference(Location)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
daysOfWeekS0..*codeBinding
allDayS0..1boolean
openingTimeS0..1time
closingTimeS0..1time
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)
idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
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
descriptionΣ0..1string
modeΣ0..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
systemS Σ I0..1codeBinding
valueS Σ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textS Σ0..1string
lineΣ0..*string
cityS Σ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
physicalTypeΣ0..1CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
longitude1..1decimal
latitude1..1decimal
altitude0..1decimal
managingOrganizationΣ I0..1Reference(Organization)
partOfI0..1Reference(Location)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
daysOfWeekS0..*codeBinding
allDayS0..1boolean
openingTimeS0..1time
closingTimeS0..1time
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)
idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
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
descriptionΣ0..1string
modeΣ0..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
systemS Σ I0..1codeBinding
valueS Σ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textS Σ0..1string
lineΣ0..*string
cityS Σ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeS Σ0..1string
countryS Σ0..1string
periodΣ I0..1Period
physicalTypeΣ0..1CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
longitude1..1decimal
latitude1..1decimal
altitude0..1decimal
managingOrganizationΣ I0..1Reference(Organization)
partOfI0..1Reference(Location)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
daysOfWeekS0..*codeBinding
allDayS0..1boolean
openingTimeS0..1time
closingTimeS0..1time
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)
Location..
Location.meta..
Location.identifier..
Location.identifier.system..
Location.identifier.value..
Location.status..
Location.name..
Location.description..
Location.mode..
Location.type..
Location.type.coding..
Location.type.coding.code..
Location.telecom..
Location.telecom.system..
Location.telecom.value..
Location.address..
Location.address.text..
Location.address.city..
Location.address.postalCode..
Location.address.country..
Location.hoursOfOperation..
Location.hoursOfOperation.daysOfWeek..
Location.hoursOfOperation.allDay..
Location.hoursOfOperation.openingTime..
Location.hoursOfOperation.closingTime..

{
    "resourceType": "StructureDefinition",
    "id": "CA-eReC-Location",
    "url": "https://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Location",
    "version": "0.1.0",
    "name": "Location",
    "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. Used to help identify the location of the patient, provider (requester and service provider), and where the service will be provided. May be used in future to conduct analytics and help requesters find best services in closer proximity to the patient.",
    "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",
                "comment": "The MustSupport flag on this element has been relaxed in this version until further confirmation of the use of meta.profile (outside of use for certain validation suites) and impact can be assessed by the working group."
            },
            {
                "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": false
            },
            {
                "id": "Location.mode",
                "path": "Location.mode",
                "binding": {
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/ValueSet/location-mode"
                }
            },
            {
                "id": "Location.type.coding",
                "path": "Location.type.coding",
                "mustSupport": true
            },
            {
                "id": "Location.type.coding.code",
                "path": "Location.type.coding.code",
                "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.text",
                "path": "Location.address.text",
                "mustSupport": true
            },
            {
                "id": "Location.address.city",
                "path": "Location.address.city",
                "mustSupport": true
            },
            {
                "id": "Location.address.postalCode",
                "path": "Location.address.postalCode",
                "mustSupport": true
            },
            {
                "id": "Location.address.country",
                "path": "Location.address.country",
                "mustSupport": true
            },
            {
                "id": "Location.hoursOfOperation.daysOfWeek",
                "path": "Location.hoursOfOperation.daysOfWeek",
                "short": "Mon | Tue | Wed | Thu | Fri | Sat | Sun",
                "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

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Used to help identify the location of the patient, provider (requester and service provider), and where the service will be provided. May be used in future to conduct analytics and help requesters find best services in closer proximity to the patient.

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)

.status

  • used to determine whether the location is still in use

.telecom

  • Location.telecom value takes precedence when provided

.address

  • Entry used for the inquiry phone, email, fax for the physical location of the individual/organization