Te Whatu Ora, Central Region Integration Hub
1.0.10-rc1 - ci-build
Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.10-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions
application/fhir+xml
,
xml
,
application/fhir+json
,
json
,
application/x-turtle
,
ttl
application/fhir+json
,
application/fhir+xml
,
application/json-patch+json
,
application/xml-patch+xml
Resouce Type | Profile | Operations | Searches | _incldue | _revinclude |
---|---|---|---|---|---|
ImplementationGuide |
Base System Profile: http://hl7.org/fhir/StructureDefinition/ImplementationGuide |
search-type ,
read
|
_id
|
||
StructureDefinition |
Base System Profile: http://hl7.org/fhir/StructureDefinition/StructureDefinition |
search-type ,
vread ,
read ,
history-type ,
history-instance
|
_id
|
||
Subscription |
Base System Profile: http://hl7.org/fhir/StructureDefinition/Subscription |
search-type ,
update ,
vread ,
read ,
patch ,
history-type ,
history-instance ,
create
|
_id
|
Interaction | Documentation |
---|---|
search-type | Queries against the resource type. Will return a Bundle (even if there are no matching resources). The search-type interaction is performed by an HTTP |
read | Retrieves a resource by its ID. Will return a single resource. The read interaction accesses the current contents of a resource. The interaction is performed by an HTTP |
Operation | Documentation |
---|---|
$validate | Checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. details - |
$meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
$diff | Examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences. |
Name | Type | Documentation |
---|---|---|
_id | token | The ID of the resource |
Interaction | Documentation |
---|---|
search-type | Queries against the resource type. Will return a Bundle (even if there are no matching resources). The search-type interaction is performed by an HTTP |
vread | Retrieves a version of a resource by its ID and version ID. Will return a single resource. The vread interaction is performed by an HTTP |
read | Retrieves a resource by its ID. Will return a single resource. The read interaction accesses the current contents of a resource. The interaction is performed by an HTTP |
history-type | Queries against the resource type. Will return a Bundle, with history of matching resources The history-type interaction is performed by an HTTP |
history-instance | Retrieves a resource by its ID. Will return a Bundle, with history of that resource The history-instance interaction is performed by an HTTP |
Operation | Documentation |
---|---|
$meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
$diff | Examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences. |
Name | Type | Documentation |
---|---|---|
_id | token | The ID of the resource |
Interaction | Documentation |
---|---|
search-type | Queries against the resource type. Will return a Bundle (even if there are no matching resources). The search-type interaction is performed by an HTTP |
update | Creates a new current version for an existing resource OR creates an initial version if no resource already exists for the given id. The update interaction is performed by an HTTP |
vread | Retrieves a version of a resource by its ID and version ID. Will return a single resource. The vread interaction is performed by an HTTP |
read | Retrieves a resource by its ID. Will return a single resource. The read interaction accesses the current contents of a resource. The interaction is performed by an HTTP |
patch | Updates some fields of the current version of a resource. This can be useful when a client is seeking to minimize its bandwidth utilization, or in scenarios where a client has only partial access or support for a resource. The patch interaction is performed by an HTTP |
history-type | Queries against the resource type. Will return a Bundle, with history of matching resources The history-type interaction is performed by an HTTP |
history-instance | Retrieves a resource by its ID. Will return a Bundle, with history of that resource The history-instance interaction is performed by an HTTP |
create | Creates a new resource in a server-assigned location. The create interaction is performed by an HTTP |
Operation | Documentation |
---|---|
$validate | Checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. details - |
$meta-delete | Delete tags, profiles, and/or security labels from a resource |
$meta-add | Add tags, profiles, and/or security labels to a resource |
$meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
$expunge | Physically delete, rather than logically delete, old versions of resources, deleted resources, etc. details - |
$diff | Examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences. |
$trigger-subscription | Triggers the Subscription as if the resources returned by the given searchUrl paratmeter had triggered the Subscription. details Only available on |
Name | Type | Documentation |
---|---|---|
_id | token |