This page is part of a downloaded copy of this specification. This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR v3.5.0. . For a full list of available versions, see the Directory of published versions

This is a pre-release version (Ballot 1) of Coverage Requirements Discovery (CRD) R1/STU. There is no current official version.
For a full list of available versions, see the Directory of published versions .

## StructureDefinition: CRD Location

The official URL for this profile is:

    http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-location-r4

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- All

This structure is derived from Location

Summary

Mandatory: 7 elements
Must-Support: 10 elements

Structures

This structure refers to these other structures:

- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-organization-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-location-r4

This structure is derived from Location

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Location |  | 0..* |  |
status | S | 0..1 | code |
name | S | 1..1 | string |
telecom | S | 0..* | ContactPoint |
address | S | 1..1 | Address |
type | S | 0..1 | code | Binding: CRD Location Address Types (required)
line | S | 1..* | string |
city | S | 1..1 | string |
state | S | 1..1 | string |
postalCode | S | 1..1 | string |
managingOrganization | S | 1..1 | Reference(CRD Organization) |
partOf |  | 0..1 | Reference(CRD Location) |
endpoint |  | 0..* | Reference(Endpoint) |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Location | I | 0..* |  | 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: Common Languages (preferred)
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
identifier | Î£ | 0..* | Identifier | Unique code or number identifying the location to its users
status | ?!S Î£ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required)
operationalStatus | Î£ | 0..1 | Coding | The Operational status of the location (typically only for a bed/room) Binding: http://terminology.hl7.org/ValueSet/v2-0116 (preferred)
name | S Î£ | 1..1 | string | Name of the location as used by humans
alias |  | 0..* | string | A list of alternate names that the location is known as or was known as in the past
description | Î£ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name
mode | Î£ | 0..1 | code | instance | kind Binding: LocationMode (required)
type | Î£ | 0..* | CodeableConcept | Type of function performed Binding: http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType (extensible)
telecom | S | 0..* | ContactPoint | Contact details of the location
address | S | 1..1 | Address | Physical location
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Î£ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home
type | S Î£ | 0..1 | code | postal | physical | both Binding: CRD Location Address Types (required) Example General': both
text | Î£ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132
line | S Î£ | 1..* | string | Street 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 | S Î£ | 1..1 | string | Name of city, town etc. Example General': Erewhon
district | Î£ | 0..1 | string | District name (aka county) Example General': Madison
state | S Î£ | 1..1 | string | Sub-unit of country (abbreviations ok)
postalCode | S Î£ | 1..1 | string | Postal code for area Example General': 9132
country | Î£ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Î£ | 0..1 | Period | Time period when address was/is in use Example General': {"start":"2010-03-23","end":"2010-07-01"}
physicalType | Î£ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example)
position | I | 0..1 | BackboneElement | The absolute geographic location
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Î£ | 0..* | Extension | Extensions that cannot be ignored if unrecognized
longitude |  | 1..1 | decimal | Longitude with WGS84 datum
latitude |  | 1..1 | decimal | Latitude with WGS84 datum
altitude |  | 0..1 | decimal | Altitude with WGS84 datum
managingOrganization | S Î£ | 1..1 | Reference(CRD Organization) | Organization responsible for provisioning and upkeep
partOf |  | 0..1 | Reference(CRD Location) | Another Location this one is physically part of
hoursOfOperation | I | 0..* | BackboneElement | What days/times during a week is this location usually open
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Î£ | 0..* | Extension | Extensions that cannot be ignored if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required)
allDay |  | 0..1 | boolean | The Location is open all day
openingTime |  | 0..1 | time | Time that the Location opens
closingTime |  | 0..1 | time | Time that the Location closes
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location
Documentation for this format

This structure is derived from Location

Summary

Mandatory: 7 elements
Must-Support: 10 elements

Structures

This structure refers to these other structures:

- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-organization-r4
- http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-location-r4

Differential View

This structure is derived from Location

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Location |  | 0..* |  |
status | S | 0..1 | code |
name | S | 1..1 | string |
telecom | S | 0..* | ContactPoint |
address | S | 1..1 | Address |
type | S | 0..1 | code | Binding: CRD Location Address Types (required)
line | S | 1..* | string |
city | S | 1..1 | string |
state | S | 1..1 | string |
postalCode | S | 1..1 | string |
managingOrganization | S | 1..1 | Reference(CRD Organization) |
partOf |  | 0..1 | Reference(CRD Location) |
endpoint |  | 0..* | Reference(Endpoint) |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Location | I | 0..* |  | 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: Common Languages (preferred)
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
identifier | Î£ | 0..* | Identifier | Unique code or number identifying the location to its users
status | ?!S Î£ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required)
operationalStatus | Î£ | 0..1 | Coding | The Operational status of the location (typically only for a bed/room) Binding: http://terminology.hl7.org/ValueSet/v2-0116 (preferred)
name | S Î£ | 1..1 | string | Name of the location as used by humans
alias |  | 0..* | string | A list of alternate names that the location is known as or was known as in the past
description | Î£ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name
mode | Î£ | 0..1 | code | instance | kind Binding: LocationMode (required)
type | Î£ | 0..* | CodeableConcept | Type of function performed Binding: http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType (extensible)
telecom | S | 0..* | ContactPoint | Contact details of the location
address | S | 1..1 | Address | Physical location
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Î£ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home
type | S Î£ | 0..1 | code | postal | physical | both Binding: CRD Location Address Types (required) Example General': both
text | Î£ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132
line | S Î£ | 1..* | string | Street 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 | S Î£ | 1..1 | string | Name of city, town etc. Example General': Erewhon
district | Î£ | 0..1 | string | District name (aka county) Example General': Madison
state | S Î£ | 1..1 | string | Sub-unit of country (abbreviations ok)
postalCode | S Î£ | 1..1 | string | Postal code for area Example General': 9132
country | Î£ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Î£ | 0..1 | Period | Time period when address was/is in use Example General': {"start":"2010-03-23","end":"2010-07-01"}
physicalType | Î£ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example)
position | I | 0..1 | BackboneElement | The absolute geographic location
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Î£ | 0..* | Extension | Extensions that cannot be ignored if unrecognized
longitude |  | 1..1 | decimal | Longitude with WGS84 datum
latitude |  | 1..1 | decimal | Latitude with WGS84 datum
altitude |  | 0..1 | decimal | Altitude with WGS84 datum
managingOrganization | S Î£ | 1..1 | Reference(CRD Organization) | Organization responsible for provisioning and upkeep
partOf |  | 0..1 | Reference(CRD Location) | Another Location this one is physically part of
hoursOfOperation | I | 0..* | BackboneElement | What days/times during a week is this location usually open
id |  | 0..1 | string | xml:id (or equivalent in JSON)
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Î£ | 0..* | Extension | Extensions that cannot be ignored if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required)
allDay |  | 0..1 | boolean | The Location is open all day
openingTime |  | 0..1 | time | Time that the Location opens
closingTime |  | 0..1 | time | Time that the Location closes
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location
Documentation for this format

Other representations of profile: Schematron

### Terminology Bindings

Path | Name | Conformance | ValueSet
Location.language | Language | preferred | Common Languages
Location.status | LocationStatus | required | LocationStatus
Location.operationalStatus | ?ext | preferred | http://terminology.hl7.org/ValueSet/v2-0116
Location.mode | LocationMode | required | LocationMode
Location.type | ?ext | extensible | http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.address.use | AddressUse | required | AddressUse
Location.address.type | CRD Location Address Types | required | CRD Location Address Types
Location.physicalType | Location type | example | LocationType
Location.hoursOfOperation.daysOfWeek | DaysOfWeek | required | DaysOfWeek

### Constraints

Id | Path | Details | Requirements
dom-2 | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-4 | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-3 | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-6 | Location | A resource should have narrative for robust management : text.div.exists() |
dom-5 | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
ele-1 | Location.position | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Location.hoursOfOperation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |