Facility Registry Implementation Guide
0.1.0 - ci-build
Facility Registry Implementation Guide
0.1.0 - ci-build
Facility Registry Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
This is standard FHIR to create a new FHIR Resource, and user SHALL use this interface to registry a new Resource.
POST [base]/Organization
POST [base]/Location
POST [base]/HealthcareService
This is a deterministic search using an Identifier search token to find matching Resources and user SHALL search by identifier using this design.
For example:
GET [base]/Organization?identifier=http://acme.org/organization|2345
GET [base]/HealthcareService?identifier=http://acme.org/healthcareservice|2345
GET [base]/Location?identifier=http://acme.org/location|2345
This Restful request is a standard FHIR search and will return a Bundle of Resources with zero or more entries.
The vread interaction SHALL be supported for these Resources.
GET [base]/Organization/123/_history/3
GET [base]/HealthcareService/123/_history/3
GET [base]/Location/123/_history/3
This query may return more than a single Resource. The more parameters used in the search the more likely a definitive single match is found. Lists of FHIR R4 search parameters available from the FHIR R4 guide. These sets are reduced to the following as list in the following sections. User SHALL use this design to search for Resources in the Facility Registry.
Consideration 🔎 This is a proposed list, which will need to be refined during later design stages.
| Parameter |
|---|
| _id |
| active |
| address |
| name |
For example,
GET [base]/Organization?name=Good%20Health
Location search is the same as Organization, except different search parameters.
Consideration 🔎 This is a proposed list, which will need to be refined during later design stages.
| Parameter |
| _id |
| address |
| name |
| near |
| status |
HealthcareService search is the same as Organization, except different search parameters.
Consideration 🔎 This is a proposed list, which will need to be refined during later design stages.
| Parameter |
| _id |
| active |
| characteristic |
| location |
| name |
| organization |
| program |
| service-category |
| service-type |
| specialty |
Given that the Resource to update has already been found, this is a standard FHIR Restful interaction that SHALL be used to update Resources. This function necessitates that FR users SHOULD search before using the Update interaction.
PUT [base]/Organization/123
PUT [base]/Location/123
PUT [base]/HealthcareService/123
Update as create - is not supported. Partial updates are not permitted.
The follow is informational only and presents some exmple queries that will be necessary.
This is a standard search with parameters.
GET [base]/HealthcareService?organization=Organization/123
This is a query against the Provider Registry and the Facility Registry.
First query Facility Registry for HealthcareServices provided by the Organization of interest.
GET [base]/HealthcareService?providedBy=Organization/123
Then query Provider Registry to return all Providers with links to those Services run by that Organization. One query per Service.
GET [base]/PractitionerRole?_include=Practitioner:practitioner&service=HealthcareService/456 GET [base]/PractitionerRole?_include=Practitioner:practitioner&service=HealthcareService/789
Since Location and Organization likely share a repository, this can be returned using _include.
GET [base]/HealthcareService?_include=Location:location&providedBy=Organization/123