FHIR Implementation Guide for NJSAMS


1.0.0 - release

NJSAMS - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NJSAMSLocation

Official URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/NJSAMSLocation Version: 1.0.0
Active as of 2025-06-23 Computable Name: NJSAMSLocation

NJSAMS Location

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocation Details and position information for a physical place
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: 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
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier Σ 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
.... identifier:licenseNum SΣ 1..1 Identifier Identifier for NJSAMS Locations
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/LicenseNo
..... value Σ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... name SΣ 1..1 string Name of the location as used by humans
ele-1: All FHIR elements must have a @value or children
... Slices for telecom SC 1..4 ContactPoint Contact details of the location
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
.... telecom:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... telecom:phone SC 1..1 ContactPoint Contact details of the location
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: phone
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... telecom:email SC 0..1 ContactPoint Contact details of the location
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: email
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... telecom:fax SC 0..1 ContactPoint Contact details of the location
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: fax
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... telecom:website SC 0..1 ContactPoint Contact details of the location
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: url
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
... address S 1..1 Address Physical location
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
.... line SΣ 0..2 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 1..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
.... district SΣ 1..1 string District name (aka county)
ele-1: All FHIR elements must have a @value or children
Example General: Madison
.... state SΣ 1..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


ele-1: All FHIR elements must have a @value or children
.... postalCode SΣ 0..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
Example General: 9132
... managingOrganization SΣC 1..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.identifier:licenseNum.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:fax.systemrequiredPattern: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:fax.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:website.systemrequiredPattern: url
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:website.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorLocation.telecom, Location.telecom:phone, Location.telecom:email, Location.telecom:fax, Location.telecom:websiteA system is required if a value is provided.
: value.empty() or system.exists()
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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.modifierExtension, Location.telecom.extension:contact-name, Location.telecom:phone.extension:contact-name, Location.telecom:email.extension:contact-name, Location.telecom:fax.extension:contact-name, Location.telecom:website.extension:contact-nameMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorLocation.managingOrganizationSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocation Details and position information for a physical place
... Slices for identifier 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:licenseNum S 1..1 Identifier Identifier for NJSAMS Locations
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/LicenseNo
..... value 0..1 string The value that is unique
... status 1..1 code active | suspended | inactive
... name 1..1 string Name of the location as used by humans
.... telecom:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
.... telecom:phone S 1..1 ContactPoint Contact details of the location
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
.... telecom:email S 0..1 ContactPoint Contact details of the location
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
.... telecom:fax S 0..1 ContactPoint Contact details of the location
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: fax
.... telecom:website S 0..1 ContactPoint Contact details of the location
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: url
... address 1..1 Address Physical location
.... line 0..2 string Street name, number, direction & P.O. Box etc.
.... city 1..1 string Name of city, town etc.
.... district S 1..1 string District name (aka county)
.... state 1..1 string Sub-unit of country (abbreviations ok)
.... postalCode 0..1 string US Zip Codes
... managingOrganization 1..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocation Details and position information for a physical place
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier Σ 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:licenseNum SΣ 1..1 Identifier Identifier for NJSAMS Locations
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/LicenseNo
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period ΣC 0..1 Period Time period when id is/was valid for use
per-1: If present, start SHALL have a lower value than end
..... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
ref-1: SHALL have a contained resource if a local reference is provided
... status ?!SΣ 1..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 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): Indicates whether a resource instance represents a specific location or a class of locations.

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


... Slices for telecom SC 1..4 ContactPoint Contact details of the location
Slice: Unordered, Open by value:system
cpt-2: A system is required if a value is provided.
.... telecom:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period ΣC 0..1 Period Time period when the contact point was/is in use
per-1: If present, start SHALL have a lower value than end
.... telecom:phone SC 1..1 ContactPoint Contact details of the location
cpt-2: A system is required if a value is provided.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period ΣC 0..1 Period Time period when the contact point was/is in use
per-1: If present, start SHALL have a lower value than end
.... telecom:email SC 0..1 ContactPoint Contact details of the location
cpt-2: A system is required if a value is provided.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period ΣC 0..1 Period Time period when the contact point was/is in use
per-1: If present, start SHALL have a lower value than end
.... telecom:fax SC 0..1 ContactPoint Contact details of the location
cpt-2: A system is required if a value is provided.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period ΣC 0..1 Period Time period when the contact point was/is in use
per-1: If present, start SHALL have a lower value than end
.... telecom:website SC 0..1 ContactPoint Contact details of the location
cpt-2: A system is required if a value is provided.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period ΣC 0..1 Period Time period when the contact point was/is in use
per-1: If present, start SHALL have a lower value than end
... address S 1..1 Address Physical location
.... id 0..1 string Unique id for inter-element referencing
.... extension N 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 Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..2 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 1..1 string District name (aka county)
Example General: Madison
.... state SΣ 1..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... 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 ΣC 0..1 Period Time period when address was/is in use
per-1: If present, start SHALL have a lower value than end
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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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ΣC 1..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep
ref-1: SHALL have a contained resource if a local reference is provided
... partOf C 0..1 Reference(Location) Another Location this one is physically a part of
ref-1: SHALL have a contained resource if a local reference is provided
... 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 C 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Location.identifier:licenseNum.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:licenseNum.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:fax.systemrequiredPattern: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:fax.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:website.systemrequiredPattern: url
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:website.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorLocation.telecom, Location.telecom:phone, Location.telecom:email, Location.telecom:fax, Location.telecom:websiteA system is required if a value is provided.
: value.empty() or system.exists()
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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.extension, Location.modifierExtension, Location.identifier:licenseNum.extension, Location.telecom.extension, Location.telecom.extension:contact-name, Location.telecom:phone.extension, Location.telecom:phone.extension:contact-name, Location.telecom:email.extension, Location.telecom:email.extension:contact-name, Location.telecom:fax.extension, Location.telecom:fax.extension:contact-name, Location.telecom:website.extension, Location.telecom:website.extension:contact-name, Location.address.extension, Location.position.extension, Location.position.modifierExtension, Location.hoursOfOperation.extension, Location.hoursOfOperation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorLocation.identifier:licenseNum.period, Location.telecom.period, Location.telecom:phone.period, Location.telecom:email.period, Location.telecom:fax.period, Location.telecom:website.period, Location.address.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorLocation.identifier:licenseNum.assigner, Location.managingOrganization, Location.partOf, Location.endpointSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from USCoreLocation

Summary

Mandatory: 12 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 1 is sliced based on the value of Location.identifier
  • The element 1 is sliced based on the value of Location.telecom

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocation Details and position information for a physical place
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: 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
dom-6: A resource should have narrative for robust management
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier Σ 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
.... identifier:licenseNum SΣ 1..1 Identifier Identifier for NJSAMS Locations
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/LicenseNo
..... value Σ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... name SΣ 1..1 string Name of the location as used by humans
ele-1: All FHIR elements must have a @value or children
... Slices for telecom SC 1..4 ContactPoint Contact details of the location
Slice: Unordered, Open by value:system
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
.... telecom:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... telecom:phone SC 1..1 ContactPoint Contact details of the location
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: phone
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... telecom:email SC 0..1 ContactPoint Contact details of the location
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: email
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... telecom:fax SC 0..1 ContactPoint Contact details of the location
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: fax
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... telecom:website SC 0..1 ContactPoint Contact details of the location
ele-1: All FHIR elements must have a @value or children
cpt-2: A system is required if a value is provided.
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: url
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
... address S 1..1 Address Physical location
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
.... line SΣ 0..2 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 1..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
.... district SΣ 1..1 string District name (aka county)
ele-1: All FHIR elements must have a @value or children
Example General: Madison
.... state SΣ 1..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


ele-1: All FHIR elements must have a @value or children
.... postalCode SΣ 0..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
Example General: 9132
... managingOrganization SΣC 1..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep
ele-1: All FHIR elements must have a @value or children
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.identifier:licenseNum.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:fax.systemrequiredPattern: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:fax.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:website.systemrequiredPattern: url
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:website.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorLocation.telecom, Location.telecom:phone, Location.telecom:email, Location.telecom:fax, Location.telecom:websiteA system is required if a value is provided.
: value.empty() or system.exists()
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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.modifierExtension, Location.telecom.extension:contact-name, Location.telecom:phone.extension:contact-name, Location.telecom:email.extension:contact-name, Location.telecom:fax.extension:contact-name, Location.telecom:website.extension:contact-nameMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorLocation.managingOrganizationSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocation Details and position information for a physical place
... Slices for identifier 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:licenseNum S 1..1 Identifier Identifier for NJSAMS Locations
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/LicenseNo
..... value 0..1 string The value that is unique
... status 1..1 code active | suspended | inactive
... name 1..1 string Name of the location as used by humans
.... telecom:All Slices Content/Rules for all slices
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
.... telecom:phone S 1..1 ContactPoint Contact details of the location
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
.... telecom:email S 0..1 ContactPoint Contact details of the location
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
.... telecom:fax S 0..1 ContactPoint Contact details of the location
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: fax
.... telecom:website S 0..1 ContactPoint Contact details of the location
..... Slices for extension Content/Rules for all slices
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: url
... address 1..1 Address Physical location
.... line 0..2 string Street name, number, direction & P.O. Box etc.
.... city 1..1 string Name of city, town etc.
.... district S 1..1 string District name (aka county)
.... state 1..1 string Sub-unit of country (abbreviations ok)
.... postalCode 0..1 string US Zip Codes
... managingOrganization 1..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..* USCoreLocation Details and position information for a physical place
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier Σ 1..* Identifier Unique code or number identifying the location to its users
Slice: Unordered, Open by value:system
.... identifier:licenseNum SΣ 1..1 Identifier Identifier for NJSAMS Locations
..... id 0..1 string Unique id for inter-element referencing
..... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Required Pattern: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/LicenseNo
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period ΣC 0..1 Period Time period when id is/was valid for use
per-1: If present, start SHALL have a lower value than end
..... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
ref-1: SHALL have a contained resource if a local reference is provided
... status ?!SΣ 1..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 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): Indicates whether a resource instance represents a specific location or a class of locations.

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


... Slices for telecom SC 1..4 ContactPoint Contact details of the location
Slice: Unordered, Open by value:system
cpt-2: A system is required if a value is provided.
.... telecom:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period ΣC 0..1 Period Time period when the contact point was/is in use
per-1: If present, start SHALL have a lower value than end
.... telecom:phone SC 1..1 ContactPoint Contact details of the location
cpt-2: A system is required if a value is provided.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period ΣC 0..1 Period Time period when the contact point was/is in use
per-1: If present, start SHALL have a lower value than end
.... telecom:email SC 0..1 ContactPoint Contact details of the location
cpt-2: A system is required if a value is provided.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period ΣC 0..1 Period Time period when the contact point was/is in use
per-1: If present, start SHALL have a lower value than end
.... telecom:fax SC 0..1 ContactPoint Contact details of the location
cpt-2: A system is required if a value is provided.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period ΣC 0..1 Period Time period when the contact point was/is in use
per-1: If present, start SHALL have a lower value than end
.... telecom:website SC 0..1 ContactPoint Contact details of the location
cpt-2: A system is required if a value is provided.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:contact-name S 0..2 HumanName Extension
URL: https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/ContactName
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period ΣC 0..1 Period Time period when the contact point was/is in use
per-1: If present, start SHALL have a lower value than end
... address S 1..1 Address Physical location
.... id 0..1 string Unique id for inter-element referencing
.... extension N 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 Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..2 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ 1..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 1..1 string District name (aka county)
Example General: Madison
.... state SΣ 1..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... 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 ΣC 0..1 Period Time period when address was/is in use
per-1: If present, start SHALL have a lower value than end
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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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ΣC 1..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep
ref-1: SHALL have a contained resource if a local reference is provided
... partOf C 0..1 Reference(Location) Another Location this one is physically a part of
ref-1: SHALL have a contained resource if a local reference is provided
... 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 N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... 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 C 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location
ref-1: SHALL have a contained resource if a local reference is provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Location.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Location.identifier:licenseNum.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Location.identifier:licenseNum.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Location.statusrequiredLocationStatus
http://hl7.org/fhir/ValueSet/location-status|4.0.1
from the FHIR Standard
Location.operationalStatuspreferredHl7VSBedStatus
http://terminology.hl7.org/ValueSet/v2-0116
Location.moderequiredLocationMode
http://hl7.org/fhir/ValueSet/location-mode|4.0.1
from the FHIR Standard
Location.typeextensibleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
Location.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:phone.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:email.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:fax.systemrequiredPattern: fax
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:fax.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.telecom:website.systemrequiredPattern: url
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Location.telecom:website.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Location.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Location.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Location.address.stateextensibleUspsTwoLetterAlphabeticCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
from the FHIR Standard
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorLocation.telecom, Location.telecom:phone, Location.telecom:email, Location.telecom:fax, Location.telecom:websiteA system is required if a value is provided.
: value.empty() or system.exists()
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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorLocation.extension, Location.modifierExtension, Location.identifier:licenseNum.extension, Location.telecom.extension, Location.telecom.extension:contact-name, Location.telecom:phone.extension, Location.telecom:phone.extension:contact-name, Location.telecom:email.extension, Location.telecom:email.extension:contact-name, Location.telecom:fax.extension, Location.telecom:fax.extension:contact-name, Location.telecom:website.extension, Location.telecom:website.extension:contact-name, Location.address.extension, Location.position.extension, Location.position.modifierExtension, Location.hoursOfOperation.extension, Location.hoursOfOperation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorLocation.identifier:licenseNum.period, Location.telecom.period, Location.telecom:phone.period, Location.telecom:email.period, Location.telecom:fax.period, Location.telecom:website.period, Location.address.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorLocation.identifier:licenseNum.assigner, Location.managingOrganization, Location.partOf, Location.endpointSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from USCoreLocation

Summary

Mandatory: 12 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 1 is sliced based on the value of Location.identifier
  • The element 1 is sliced based on the value of Location.telecom

 

Other representations of profile: CSV, Excel, Schematron