Te Whatu Ora, Central Region Integration Hub
1.0.12-rc1 - ci-build New Zealand flag

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.12-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

Foundation Resources

API Summary (Generated from the CapabilityStatement: nzcr-SmileCDR)

Central Region Integration Hub

  • Implementation Guide Version: 1.0.12-rc1
  • FHIR Version: 4.0.1
  • Formats: application/fhir+xml, xml, application/fhir+json, json, application/x-turtle, ttl
  • Patch Formats: application/fhir+json, application/fhir+xml, application/json-patch+json, application/xml-patch+xml
  • Published On: 2023-11-23T01:55:44.321+00:00
  • Published By: Te Whatu Ora, Te Pae Ora o Ruahine o Tararua - Health NZ, Mid-Central
Note: Complete documentation on FHIR REST operations is available at FHIR RESTful API

Capabilities by Resource/Profile:
Resouce TypeProfileOperationsSearches_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

ImplementationGuide


Interactions:
InteractionDocumentation
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 GET command - [base]/[resource-type]/_search

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 GET command


Extended Operations
OperationDocumentation
$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 - [base]/[Resource]/[id]/$validate

$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.


Search Parameters:
NameTypeDocumentation
_id token

The ID of the resource


StructureDefinition


Interactions:
InteractionDocumentation
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 GET command - [base]/[resource-type]/_search

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 GET command - [base]/[resource-type]/[id]/_history/[vid]

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 GET command

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 GET command - [base]/[resource-type]/_history

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 GET command - [base]/[resource-type]/[id]/_history


Extended Operations
OperationDocumentation
$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.


Search Parameters:
NameTypeDocumentation
_id token

The ID of the resource


Subscription


Interactions:
InteractionDocumentation
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 GET command - [base]/[resource-type]/_search

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 PUT command

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 GET command - [base]/[resource-type]/[id]/_history/[vid]

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 GET command

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 PATCH command

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 GET command - [base]/[resource-type]/_history

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 GET command - [base]/[resource-type]/[id]/_history

create

Creates a new resource in a server-assigned location. The create interaction is performed by an HTTP POST command.


Extended Operations
OperationDocumentation
$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 - [base]/[Resource]/[id]/$validate

$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 - [base]/[Resource]/[id]/$expunge

$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 test-smileCDR.mdhb.health.nz instance.


Search Parameters:
NameTypeDocumentation
_id token