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. The current version which supercedes this version is 1.0.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.

This structure is derived from Location

Summary

Mandatory: 7 elements
Must-Support: 10 elements

Structures

This structure refers to these other structures:

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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!SΣ0..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... operationalStatus Σ0..1CodingThe Operational status of the location (typically only for a bed/room)
Binding: http://terminology.hl7.org/ValueSet/v2-0116 (preferred)
... name SΣ1..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
... mode Σ0..1codeinstance | kind
Binding: LocationMode (required)
... type Σ0..*CodeableConceptType of function performed
Binding: http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType (extensible)
... telecom S0..*ContactPointContact details of the location
... address S1..1AddressPhysical location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type SΣ0..1codepostal | physical | both
Binding: CRD Location Address Types (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ1..*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 SΣ1..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ1..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ1..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 if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ1..1Reference(CRD Organization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(CRD 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 if unrecognized
.... 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

This structure is derived from Location

Summary

Mandatory: 7 elements
Must-Support: 10 elements

Structures

This structure refers to these other structures:

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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!SΣ0..1codeactive | suspended | inactive
Binding: LocationStatus (required)
... operationalStatus Σ0..1CodingThe Operational status of the location (typically only for a bed/room)
Binding: http://terminology.hl7.org/ValueSet/v2-0116 (preferred)
... name SΣ1..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
... mode Σ0..1codeinstance | kind
Binding: LocationMode (required)
... type Σ0..*CodeableConceptType of function performed
Binding: http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType (extensible)
... telecom S0..*ContactPointContact details of the location
... address S1..1AddressPhysical location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type SΣ0..1codepostal | physical | both
Binding: CRD Location Address Types (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ1..*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 SΣ1..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ1..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ1..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 if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ1..1Reference(CRD Organization)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(CRD 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 if unrecognized
.... 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

 

Other representations of profile: Schematron

Terminology Bindings

PathNameConformanceValueSet
Location.languageLanguagepreferredCommon Languages
Location.statusLocationStatusrequiredLocationStatus
Location.operationalStatus?extpreferredhttp://terminology.hl7.org/ValueSet/v2-0116
Location.modeLocationModerequiredLocationMode
Location.type?extextensiblehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.address.useAddressUserequiredAddressUse
Location.address.typeCRD Location Address TypesrequiredCRD Location Address Types
Location.physicalTypeLocation typeexampleLocationType
Location.hoursOfOperation.daysOfWeekDaysOfWeekrequiredDaysOfWeek

Constraints

IdPathDetailsRequirements
dom-2LocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4LocationIf 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-3LocationIf 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-6LocationA resource should have narrative for robust management
: text.div.exists()
dom-5LocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1Location.positionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Location.hoursOfOperationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())