locations

Create Location

post
/organizations/{organizationId}/fhir/4/Location

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Location resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Unique code or number identifying the location to its users.
statusactive|suspended|inactiveThe status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
operationalStatusCodingThe operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
namestringName of the location as used by humans. Does not need to be unique.
aliasarray(string)A list of alternate names that the location is known as, or was known as, in the past.
descriptionstringDescription of the Location, which helps in finding or referencing the place.
modeinstance|kindIndicates whether a resource instance represents a specific location or a class of locations.
typearray(CodeableConcept)Indicates the type of function performed at the location.
telecomarray(ContactPoint)The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
addressAddressPhysical location.
physicalTypeCodeableConceptPhysical form of the location, e.g. building, room, vehicle, road.
positionLocation_PositionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
managingOrganizationReferenceThe organization responsible for the provisioning and upkeep of the location.
partOfReferenceAnother Location of which this Location is physically a part of.
hoursOfOperationarray(Location_HoursOfOperation)What days/times during a week is this location usually open.
availabilityExceptionsstringA description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
endpointarray(Reference)Technical endpoints providing access to services operated for the location.

Response

Patch Location

patch
/organizations/{organizationId}/fhir/4/Location/{resourceId}

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Location resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Unique code or number identifying the location to its users.
statusactive|suspended|inactiveThe status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
operationalStatusCodingThe operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
namestringName of the location as used by humans. Does not need to be unique.
aliasarray(string)A list of alternate names that the location is known as, or was known as, in the past.
descriptionstringDescription of the Location, which helps in finding or referencing the place.
modeinstance|kindIndicates whether a resource instance represents a specific location or a class of locations.
typearray(CodeableConcept)Indicates the type of function performed at the location.
telecomarray(ContactPoint)The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
addressAddressPhysical location.
physicalTypeCodeableConceptPhysical form of the location, e.g. building, room, vehicle, road.
positionLocation_PositionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
managingOrganizationReferenceThe organization responsible for the provisioning and upkeep of the location.
partOfReferenceAnother Location of which this Location is physically a part of.
hoursOfOperationarray(Location_HoursOfOperation)What days/times during a week is this location usually open.
availabilityExceptionsstringA description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
endpointarray(Reference)Technical endpoints providing access to services operated for the location.

Response

Read Location

get
/organizations/{organizationId}/fhir/4/Location/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Location

get
/organizations/{organizationId}/fhir/4/Location/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Location

get
/organizations/{organizationId}/fhir/4/Location/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Location

delete
/organizations/{organizationId}/fhir/4/Location/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Location

get
/organizations/{organizationId}/fhir/4/Location

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
endpointstring
identifierstring
namestring
nearstring
operational-statusstring
organizationstring
partofstring
statusstring
typestring

Params

organizationId*string|stringid|slug

Response

Search History Location

get
/organizations/{organizationId}/fhir/4/Location/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Location

post
/organizations/{organizationId}/fhir/4/Location/_search

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
addressstring
address-citystring
address-countrystring
address-postalcodestring
address-statestring
address-usestring
endpointstring
identifierstring
namestring
nearstring
operational-statusstring
organizationstring
partofstring
statusstring
typestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Location resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Unique code or number identifying the location to its users.
statusactive|suspended|inactiveThe status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
operationalStatusCodingThe operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
namestringName of the location as used by humans. Does not need to be unique.
aliasarray(string)A list of alternate names that the location is known as, or was known as, in the past.
descriptionstringDescription of the Location, which helps in finding or referencing the place.
modeinstance|kindIndicates whether a resource instance represents a specific location or a class of locations.
typearray(CodeableConcept)Indicates the type of function performed at the location.
telecomarray(ContactPoint)The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
addressAddressPhysical location.
physicalTypeCodeableConceptPhysical form of the location, e.g. building, room, vehicle, road.
positionLocation_PositionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
managingOrganizationReferenceThe organization responsible for the provisioning and upkeep of the location.
partOfReferenceAnother Location of which this Location is physically a part of.
hoursOfOperationarray(Location_HoursOfOperation)What days/times during a week is this location usually open.
availabilityExceptionsstringA description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
endpointarray(Reference)Technical endpoints providing access to services operated for the location.

Response

Update Location

put
/organizations/{organizationId}/fhir/4/Location/{resourceId}

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Location resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)Unique code or number identifying the location to its users.
statusactive|suspended|inactiveThe status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
operationalStatusCodingThe operational status covers operation values most relevant to beds (but can also apply to rooms/units/chairs/etc. such as an isolation unit/dialysis chair). This typically covers concepts such as contamination, housekeeping, and other activities like maintenance.
namestringName of the location as used by humans. Does not need to be unique.
aliasarray(string)A list of alternate names that the location is known as, or was known as, in the past.
descriptionstringDescription of the Location, which helps in finding or referencing the place.
modeinstance|kindIndicates whether a resource instance represents a specific location or a class of locations.
typearray(CodeableConcept)Indicates the type of function performed at the location.
telecomarray(ContactPoint)The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
addressAddressPhysical location.
physicalTypeCodeableConceptPhysical form of the location, e.g. building, room, vehicle, road.
positionLocation_PositionThe absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
managingOrganizationReferenceThe organization responsible for the provisioning and upkeep of the location.
partOfReferenceAnother Location of which this Location is physically a part of.
hoursOfOperationarray(Location_HoursOfOperation)What days/times during a week is this location usually open.
availabilityExceptionsstringA description of when the locations opening ours are different to normal, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as detailed in the opening hours Times.
endpointarray(Reference)Technical endpoints providing access to services operated for the location.

Response