Da Vinci - Coverage Requirements Discovery
2.1.0-preview - STU 2
Da Vinci - Coverage Requirements Discovery
2.1.0-preview - STU 2
This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.1.0-preview: STU 2.1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.1. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-location | Version: 2.1.0-preview | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: CRDLocation | ||
This profile specifies constraints on the US Core Location profile to support coverage requirements discovery.
CRD Clients SHALL use this profile to resolve references to insurance Location resources passed to CRD Servers.
Information provided in Must Support elements will commonly be required for CRD Servers to perform coverage requirements discovery.
The location types codes must come from HL7-defined codes when possible. A ConceptMap to CMS location codes is available here.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreLocationProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Location |
C | 0..* | USCoreLocationProfile(7.0.0) | Details and position information for a physical place This profile also complies with the profiles US Core Location Profile (3.1.1) and US Core Location Profile (6.1.0) crd-loc1: Must either have a type or must have a parent (meaning there must be a type somewhere in the hierarchy) |
  type |
SC | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: CMS Mappable Location Codes (extensible) |
 address |
1..1 | Address | Physical location | |
  type |
S | 0..1 | code | physical | both Binding: CRD Location Address Types Value Set (required): Address Type for CRD |
 managingOrganization |
1..1 | Reference(CRD Organization) | Organization responsible for provisioning and upkeep | |
| partOf |
C | 0..1 | Reference(CRD Location) | Another Location this one is physically a part of |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Location.type | extensible | CMSMappableLocationCodeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/CMSMappableLocationCodesfrom this IG | |
| Location.address.type | required | CRDLocationAddressTypeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/locationAddressTypefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| crd-loc1 | error | Location | Must either have a type or must have a parent (meaning there must be a type somewhere in the hierarchy) : type.exists() or partOf.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location |
C | 0..* | USCoreLocationProfile(7.0.0) | Details and position information for a physical place This profile also complies with the profiles US Core Location Profile (3.1.1) and US Core Location Profile (6.1.0) crd-loc1: Must either have a type or must have a parent (meaning there must be a type somewhere in the hierarchy) |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
SΣ | 0..* | Identifier | Unique business identifier for facility or location. |
| status |
?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| name |
SΣ | 1..1 | string | Name by which a facility or location is known. |
| type |
SΣC | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: CMS Mappable Location Codes (extensible) |
| telecom |
S | 0..* | ContactPoint | Contact details of the location |
| address |
S | 1..1 | Address | Physical location |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type |
SΣ | 0..1 | code | physical | both Binding: CRD Location Address Types Value Set (required): Address Type for CRD Example General: both |
| 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 Example General: 49 MEADOW ST |
| city |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN |
| state |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example General: OK |
| postalCode |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example General: 74047 |
| managingOrganization |
SΣ | 1..1 | Reference(CRD Organization) | Organization responsible for provisioning and upkeep |
| partOf |
C | 0..1 | Reference(CRD Location) | Another Location this one is physically a part of |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1from the FHIR Standard | |
| Location.type | extensible | CMSMappableLocationCodeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/CMSMappableLocationCodesfrom this IG | |
| Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Location.address.type | required | CRDLocationAddressTypeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/locationAddressTypefrom this IG | |
| Location.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state |
| Id | Grade | Path(s) | Details | Requirements |
| crd-loc1 | error | Location | Must either have a type or must have a parent (meaning there must be a type somewhere in the hierarchy) : type.exists() or partOf.exists() | |
| dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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-4 | error | 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-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location |
C | 0..* | USCoreLocationProfile(7.0.0) | Details and position information for a physical place This profile also complies with the profiles US Core Location Profile (3.1.1) and US Core Location Profile (6.1.0) crd-loc1: Must either have a type or must have a parent (meaning there must be a type somewhere in the hierarchy) | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| 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 |
SΣ | 0..* | Identifier | Unique business identifier for facility or location. | ||||
| status |
?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
| operationalStatus |
Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
| name |
SΣ | 1..1 | string | Name by which a facility or location is known. | ||||
| 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): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
| type |
SΣC | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: CMS Mappable Location Codes (extensible) | ||||
| telecom |
S | 0..* | ContactPoint | Contact details of the location | ||||
| address |
S | 1..1 | Address | Physical location | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| 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): The use of an address. Example General: home | ||||
| type |
SΣ | 0..1 | code | physical | both Binding: CRD Location Address Types Value Set (required): Address Type for CRD 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 Example General: 49 MEADOW ST | ||||
| city |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN | ||||
| 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): Two letter USPS alphabetic codes. Example General: OK | ||||
| postalCode |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example General: 74047 | ||||
| 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): Physical form of the location. | ||||
| position |
0..1 | BackboneElement | The absolute geographic location | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even 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 |
C | 0..1 | Reference(CRD Location) | Another Location this one is physically a part of | ||||
| hoursOfOperation |
0..* | BackboneElement | What days/times during a week is this location usually open | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1from the FHIR Standard | ||||
| Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
| Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1from the FHIR Standard | ||||
| Location.type | extensible | CMSMappableLocationCodeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/CMSMappableLocationCodesfrom this IG | ||||
| Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Location.address.type | required | CRDLocationAddressTypeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/locationAddressTypefrom this IG | ||||
| Location.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-typefrom the FHIR Standard | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| crd-loc1 | error | Location | Must either have a type or must have a parent (meaning there must be a type somewhere in the hierarchy) : type.exists() or partOf.exists() | |
| dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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-4 | error | 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-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreLocationProfile
Summary
Mandatory: 2 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Maturity: 2
Differential View
This structure is derived from USCoreLocationProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location |
C | 0..* | USCoreLocationProfile(7.0.0) | Details and position information for a physical place This profile also complies with the profiles US Core Location Profile (3.1.1) and US Core Location Profile (6.1.0) crd-loc1: Must either have a type or must have a parent (meaning there must be a type somewhere in the hierarchy) |
| type |
SC | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: CMS Mappable Location Codes (extensible) |
| address |
1..1 | Address | Physical location | |
| type |
S | 0..1 | code | physical | both Binding: CRD Location Address Types Value Set (required): Address Type for CRD |
| managingOrganization |
1..1 | Reference(CRD Organization) | Organization responsible for provisioning and upkeep | |
| partOf |
C | 0..1 | Reference(CRD Location) | Another Location this one is physically a part of |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Location.type | extensible | CMSMappableLocationCodeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/CMSMappableLocationCodesfrom this IG | |
| Location.address.type | required | CRDLocationAddressTypeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/locationAddressTypefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| crd-loc1 | error | Location | Must either have a type or must have a parent (meaning there must be a type somewhere in the hierarchy) : type.exists() or partOf.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location |
C | 0..* | USCoreLocationProfile(7.0.0) | Details and position information for a physical place This profile also complies with the profiles US Core Location Profile (3.1.1) and US Core Location Profile (6.1.0) crd-loc1: Must either have a type or must have a parent (meaning there must be a type somewhere in the hierarchy) |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 0..* | Identifier | Unique business identifier for facility or location. |
| status |
?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| name |
SΣ | 1..1 | string | Name by which a facility or location is known. |
| type |
SΣC | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: CMS Mappable Location Codes (extensible) |
| telecom |
S | 0..* | ContactPoint | Contact details of the location |
| address |
S | 1..1 | Address | Physical location |
| use |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type |
SΣ | 0..1 | code | physical | both Binding: CRD Location Address Types Value Set (required): Address Type for CRD Example General: both |
| 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 Example General: 49 MEADOW ST |
| city |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN |
| state |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example General: OK |
| postalCode |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example General: 74047 |
| managingOrganization |
SΣ | 1..1 | Reference(CRD Organization) | Organization responsible for provisioning and upkeep |
| partOf |
C | 0..1 | Reference(CRD Location) | Another Location this one is physically a part of |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1from the FHIR Standard | |
| Location.type | extensible | CMSMappableLocationCodeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/CMSMappableLocationCodesfrom this IG | |
| Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Location.address.type | required | CRDLocationAddressTypeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/locationAddressTypefrom this IG | |
| Location.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state |
| Id | Grade | Path(s) | Details | Requirements |
| crd-loc1 | error | Location | Must either have a type or must have a parent (meaning there must be a type somewhere in the hierarchy) : type.exists() or partOf.exists() | |
| dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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-4 | error | 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-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location |
C | 0..* | USCoreLocationProfile(7.0.0) | Details and position information for a physical place This profile also complies with the profiles US Core Location Profile (3.1.1) and US Core Location Profile (6.1.0) crd-loc1: Must either have a type or must have a parent (meaning there must be a type somewhere in the hierarchy) | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| 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 |
SΣ | 0..* | Identifier | Unique business identifier for facility or location. | ||||
| status |
?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
| operationalStatus |
Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). | ||||
| name |
SΣ | 1..1 | string | Name by which a facility or location is known. | ||||
| 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): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
| type |
SΣC | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: CMS Mappable Location Codes (extensible) | ||||
| telecom |
S | 0..* | ContactPoint | Contact details of the location | ||||
| address |
S | 1..1 | Address | Physical location | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| 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): The use of an address. Example General: home | ||||
| type |
SΣ | 0..1 | code | physical | both Binding: CRD Location Address Types Value Set (required): Address Type for CRD 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 Example General: 49 MEADOW ST | ||||
| city |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN | ||||
| 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): Two letter USPS alphabetic codes. Example General: OK | ||||
| postalCode |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example General: 74047 | ||||
| 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): Physical form of the location. | ||||
| position |
0..1 | BackboneElement | The absolute geographic location | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even 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 |
C | 0..1 | Reference(CRD Location) | Another Location this one is physically a part of | ||||
| hoursOfOperation |
0..* | BackboneElement | What days/times during a week is this location usually open | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
| 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1from the FHIR Standard | ||||
| Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
| Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1from the FHIR Standard | ||||
| Location.type | extensible | CMSMappableLocationCodeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/CMSMappableLocationCodesfrom this IG | ||||
| Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Location.address.type | required | CRDLocationAddressTypeshttp://hl7.org/fhir/us/davinci-crd/ValueSet/locationAddressTypefrom this IG | ||||
| Location.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-typefrom the FHIR Standard | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| crd-loc1 | error | Location | Must either have a type or must have a parent (meaning there must be a type somewhere in the hierarchy) : type.exists() or partOf.exists() | |
| dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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-4 | error | 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-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreLocationProfile
Summary
Mandatory: 2 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-crd#2.1.0-preview based on FHIR 4.0.1. Generated 2024-09-26
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change