FHIR Implementation Guide for NJSAMS


0.1.0 - draft New Jersey

NJSAMS - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: NJSAMSLocation

Official URL: http://dhs.nj.gov/njsams/StructureDefinition/NJSAMSLocation Version: 0.1.0
Active as of 2022-09-13 Computable Name: NJSAMSLocation

NJSAMS Location

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreLocation

Summary

Mandatory: 14 elements (3 nested mandatory elements)
Must-Support: 11 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Location.identifier is sliced based on the value of value:system
  • The element Location.telecom is sliced based on the value of value:system

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... Slices for identifier 1..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:licenseNum S1..1IdentifierIdentifier for NJSAMS Locations
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://dhs.nj.gov/njsams/LicenseNo
..... value 0..1stringThe value that is unique
... status 1..1codeactive | suspended | inactive
... name 1..1stringName of the location as used by humans
.... telecom:All Slices Content/Rules for all slices
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
.... telecom:phone S1..1ContactPointContact details of the location
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: phone
.... telecom:email S0..1ContactPointContact details of the location
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: email
.... telecom:fax S0..1ContactPointContact details of the location
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: fax
.... telecom:website S0..1ContactPointContact details of the location
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: url
... address 1..1AddressPhysical location
.... line 1..2stringStreet name, number, direction & P.O. Box etc.
.... city 1..1stringName of city, town etc.
.... district S1..1stringDistrict name (aka county)
.... state 1..1stringSub-unit of country (abbreviations ok)
.... postalCode 1..1stringUS Zip Codes
... managingOrganization 1..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails 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
... 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
... Slices for identifier Σ1..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:licenseNum SΣ1..1IdentifierIdentifier for NJSAMS Locations
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://dhs.nj.gov/njsams/LicenseNo
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe 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..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): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... Slices for telecom S1..4ContactPointContact details of the location
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:phone S1..1ContactPointContact details of the location
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:email S0..1ContactPointContact details of the location
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:fax S0..1ContactPointContact details of the location
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: fax
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:website S0..1ContactPointContact details of the location
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: url
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address S1..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... 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): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ1..2stringStreet 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 SΣ1..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ1..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ1..1stringUS Zip Codes
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): Physical form of the location.

... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ1..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... identifier:licenseNum Σ1..1IdentifierIdentifier for NJSAMS Locations
... status ?!Σ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... name Σ1..1stringName of the location as used by humans
.... telecom:All Slices Content/Rules for all slices
..... contact-name 0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
.... telecom:phone 1..1ContactPointContact details of the location
..... contact-name 0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
.... telecom:email 0..1ContactPointContact details of the location
..... contact-name 0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
.... telecom:fax 0..1ContactPointContact details of the location
..... contact-name 0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
.... telecom:website 0..1ContactPointContact details of the location
..... contact-name 0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
... address 1..1AddressPhysical location
.... line Σ1..2stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city Σ1..1stringName of city, town etc.
.... district Σ1..1stringDistrict name (aka county)
.... state Σ1..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode Σ1..1stringUS Zip Codes
... managingOrganization Σ1..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep

doco Documentation for this format

This structure is derived from USCoreLocation

Summary

Mandatory: 14 elements (3 nested mandatory elements)
Must-Support: 11 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Location.identifier is sliced based on the value of value:system
  • The element Location.telecom is sliced based on the value of value:system

Differential View

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... Slices for identifier 1..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:licenseNum S1..1IdentifierIdentifier for NJSAMS Locations
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://dhs.nj.gov/njsams/LicenseNo
..... value 0..1stringThe value that is unique
... status 1..1codeactive | suspended | inactive
... name 1..1stringName of the location as used by humans
.... telecom:All Slices Content/Rules for all slices
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
.... telecom:phone S1..1ContactPointContact details of the location
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: phone
.... telecom:email S0..1ContactPointContact details of the location
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: email
.... telecom:fax S0..1ContactPointContact details of the location
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: fax
.... telecom:website S0..1ContactPointContact details of the location
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: url
... address 1..1AddressPhysical location
.... line 1..2stringStreet name, number, direction & P.O. Box etc.
.... city 1..1stringName of city, town etc.
.... district S1..1stringDistrict name (aka county)
.... state 1..1stringSub-unit of country (abbreviations ok)
.... postalCode 1..1stringUS Zip Codes
... managingOrganization 1..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails 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
... 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
... Slices for identifier Σ1..*IdentifierUnique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:licenseNum SΣ1..1IdentifierIdentifier for NJSAMS Locations
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://dhs.nj.gov/njsams/LicenseNo
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe 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..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): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ0..*CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.


... Slices for telecom S1..4ContactPointContact details of the location
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:phone S1..1ContactPointContact details of the location
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:email S0..1ContactPointContact details of the location
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:fax S0..1ContactPointContact details of the location
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: fax
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:website S0..1ContactPointContact details of the location
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contact-name S0..2HumanNameExtension
URL: http://dhs.nj.gov/njsams/StructureDefinition/ContactName
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: url
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address S1..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... 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): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ1..2stringStreet 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 SΣ1..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ1..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ1..1stringUS Zip Codes
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): Physical form of the location.

... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ1..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... 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: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Location.languagepreferredCommonLanguages
Max Binding: AllLanguages
Location.identifier:licenseNum.userequiredIdentifierUse
Location.identifier:licenseNum.typeextensibleIdentifier Type Codes
Location.statusrequiredLocationStatus
Location.operationalStatuspreferredHl7VSBedStatus
Location.moderequiredLocationMode
Location.typeextensibleServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
Location.telecom.userequiredContactPointUse
Location.telecom:phone.systemrequiredPattern: phone
Location.telecom:phone.userequiredContactPointUse
Location.telecom:email.systemrequiredPattern: email
Location.telecom:email.userequiredContactPointUse
Location.telecom:fax.systemrequiredPattern: fax
Location.telecom:fax.userequiredContactPointUse
Location.telecom:website.systemrequiredPattern: url
Location.telecom:website.userequiredContactPointUse
Location.address.userequiredAddressUse
Location.address.typerequiredAddressType
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePathDetailsRequirements
dom-2errorLocationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorLocationIf 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-4errorLocationIf 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-5errorLocationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeLocationA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorLocation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.identifier:licenseNumAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.identifier:licenseNum.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.identifier:licenseNum.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.identifier:licenseNum.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.identifier:licenseNum.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.identifier:licenseNum.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.identifier:licenseNum.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.identifier:licenseNum.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.identifier:licenseNum.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.operationalStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.aliasAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.telecom.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.telecom.extension:contact-nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.telecom.extension:contact-nameMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.telecom.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:phoneAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:phone.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.telecom:phone.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.telecom:phone.extension:contact-nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.telecom:phone.extension:contact-nameMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.telecom:phone.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:phone.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:phone.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:phone.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:phone.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:emailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:email.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.telecom:email.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.telecom:email.extension:contact-nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.telecom:email.extension:contact-nameMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.telecom:email.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:email.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:email.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:email.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:email.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:faxAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:fax.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.telecom:fax.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.telecom:fax.extension:contact-nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.telecom:fax.extension:contact-nameMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.telecom:fax.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:fax.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:fax.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:fax.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:fax.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:websiteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:website.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.telecom:website.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.telecom:website.extension:contact-nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.telecom:website.extension:contact-nameMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.telecom:website.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:website.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:website.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:website.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.telecom:website.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.address.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.lineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.address.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.physicalTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.positionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.position.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.position.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.position.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.position.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.position.longitudeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.position.latitudeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.position.altitudeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.managingOrganizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.partOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.hoursOfOperationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.hoursOfOperation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.hoursOfOperation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.hoursOfOperation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.hoursOfOperation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorLocation.hoursOfOperation.daysOfWeekAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.hoursOfOperation.allDayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.hoursOfOperation.openingTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.hoursOfOperation.closingTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.availabilityExceptionsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorLocation.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())