0.3.0 - Second STU ballot

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.3.0: STU 1 Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

## StructureDefinition: LocationSTU3

The official URL for this profile is:

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

### 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 US Core Location Profile

Summary

Mandatory: 2 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

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

This structure is derived from US Core Location Profile

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Location |  | 0..* |  |
address | S | 1..1 | Address |
type | S | 0..1 | code | Binding: CRD Location Address Types (required)
managingOrganization | S | 1..1 | Reference(OrganizationSTU3) |
partOf |  | 0..1 | Reference(LocationSTU3) |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Location | I | 0..* |  | US Core Location Profile
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 (extensible) Max Binding: All Languages
text | I | 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: v2 Bed Status (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..1 | CodeableConcept | Type of function performed Binding: 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 - 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 Σ | 0..* | 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 Σ | 0..1 | string | Name of city, town etc. Example General': Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General': Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible)
postalCode | S Σ | 0..1 | string | US Zip Codes 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-23T01:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}
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
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(OrganizationSTU3) | Organization responsible for provisioning and upkeep
partOf |  | 0..1 | Reference(LocationSTU3) | Another Location this one is physically part of
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location
Documentation for this format

This structure is derived from US Core Location Profile

Summary

Mandatory: 2 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

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

Differential View

This structure is derived from US Core Location Profile

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Location |  | 0..* |  |
address | S | 1..1 | Address |
type | S | 0..1 | code | Binding: CRD Location Address Types (required)
managingOrganization | S | 1..1 | Reference(OrganizationSTU3) |
partOf |  | 0..1 | Reference(LocationSTU3) |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Location | I | 0..* |  | US Core Location Profile
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 (extensible) Max Binding: All Languages
text | I | 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: v2 Bed Status (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..1 | CodeableConcept | Type of function performed Binding: 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 - 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 Σ | 0..* | 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 Σ | 0..1 | string | Name of city, town etc. Example General': Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General': Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible)
postalCode | S Σ | 0..1 | string | US Zip Codes 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-23T01:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}
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
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(OrganizationSTU3) | Organization responsible for provisioning and upkeep
partOf |  | 0..1 | Reference(LocationSTU3) | Another Location this one is physically part of
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 | Conformance | ValueSet
Location.status | required | LocationStatus
Location.address.type | required | CRDLocationAddressTypes
Location.address.state | extensible | USPS Two Letter Alphabetic Codes

### 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-1 | Location | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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 : contained.where(('#'+id in %resource.descendants().reference).not()).empty() |
ele-1 | Location.position | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |