PointClickCare FHIR API

PointClickCare (4.0)

Download OpenAPI specification:Download

API Error Codes:

400 Bad Request
401 Client Unauthorized
403 Forbidden
404 Not Found
500 Internal Error
405 Method Not Allowed
501 Not Implemented
422 Unprocessable Entity
409 Conflict
410 Gone
412 Precondition Failed

System Level Operations

Server-level operations

server-capabilities: Fetch the server FHIR CapabilityStatement

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
"{\n \"resourceType\": \"CapabilityStatement\"\n}"

/{tenantId}/$export-poll-status

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
_jobId
any

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

/{tenantId}/$export-poll-status

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

Request Body schema: application/fhir+json
object (FHIR Resource)

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Request samples

Content type
application/fhir+json
"{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"_jobId\",\n \"valueString\": \"example\"\n } ]\n}"

Response samples

Content type
null

AllergyIntolerance

read-instance: Read AllergyIntolerance instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for AllergyIntolerance instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

External ids for this item

clinical-status
any

active | inactive | resolved
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
versionId
any
patient
any

Who the sensitivity is for

tag
any

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for AllergyIntolerance instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

External ids for this item

clinical-status
any

active | inactive | resolved
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
versionId
any
patient
any

Who the sensitivity is for

tag
any

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read CarePlan instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for CarePlan instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

Time period plan covers

identifier
any

External Ids for this plan

lastUpdated
any
versionId
any
patient
any

Who the care plan is for

tag
any
category
any

Type of plan
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
status
any

draft | active | on-hold | revoked | completed | entered-in-error | unknown
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for CarePlan instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

Time period plan covers

identifier
any

External Ids for this plan

lastUpdated
any
versionId
any
patient
any

Who the care plan is for

tag
any
category
any

Type of plan
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
status
any

draft | active | on-hold | revoked | completed | entered-in-error | unknown
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read CareTeam instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for CareTeam instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

External Ids for this team

lastUpdated
any
versionId
any
patient
any

Who care team is for

tag
any
status
any

proposed | active | suspended | inactive | entered-in-error
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for CareTeam instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

External Ids for this team

lastUpdated
any
versionId
any
patient
any

Who care team is for

tag
any
status
any

proposed | active | suspended | inactive | entered-in-error
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

Condition

The Condition FHIR resource type

Note: Health concerns and Problem lists are available through the Condition resource


Base profile: http://hl7.org/fhir/R4/condition.html
Supported profile: https://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-condition.html

read-instance: Read Condition instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Condition instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

A unique identifier of the condition record

code
any

Code for the condition

clinical-status
any

The clinical status of the condition
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
encounter
any

Encounter created as part of

onset-date
any

Date related onsets (dateTime and Period)
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
security
any
versionId
any
patient
any

Who has the condition?

tag
any
category
any

The category of the condition
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Condition instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

A unique identifier of the condition record

code
any

Code for the condition

clinical-status
any

The clinical status of the condition
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
encounter
any

Encounter created as part of

onset-date
any

Date related onsets (dateTime and Period)
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
security
any
versionId
any
patient
any

Who has the condition?

tag
any
category
any

The category of the condition
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read Device instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Device instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

Instance id from manufacturer, owner, and others

type
any

The type of the device
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
versionId
any
patient
any

Patient information, if the resource is affixed to a person
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
tag
any

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Device instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

Instance id from manufacturer, owner, and others

type
any

The type of the device
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
versionId
any
patient
any

Patient information, if the resource is affixed to a person
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
tag
any

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read DiagnosticReport instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for DiagnosticReport instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

The clinically relevant time of the report

identifier
any

An identifier for the report

code
any

The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result

lastUpdated
any
versionId
any
patient
any

The subject of the report if a patient

tag
any
category
any

Which diagnostic discipline/department created the report
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
status
any

The status of the report
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for DiagnosticReport instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

The clinically relevant time of the report

identifier
any

An identifier for the report

code
any

The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result

lastUpdated
any
versionId
any
patient
any

The subject of the report if a patient

tag
any
category
any

Which diagnostic discipline/department created the report
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
status
any

The status of the report
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

DocumentReference

read-instance: Read DocumentReference instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for DocumentReference instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

When this document reference was created
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
identifier
any

Master Version Specific Identifier

period
any

Time of service that is being documented
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

When used for searching for CCD documents (type=http://loinc.org|34133-9 OR type=34133-9), a subset of the FHIR specification is allowed:

  1. period={qualifier}{date} Qualifier: gt (greater than), lt (less than), ge (greater than or equal to), le (less than or equal to)
  2. period={date} Inferred qualifier of eq (equals)
  3. period={qualifier}{date}&period={qualifier}{date} Qualifier: one gt and one lt Date formats: yyyy-MM-dd
type
any

Kind of document (LOINC if possible)

lastUpdated
any
versionId
any
patient
any

Who/what is the subject of the document

tag
any
_id
any

The ID of the resource

category
any

Categorization of document
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
status
any

current | superseded | entered-in-error
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for DocumentReference instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

When this document reference was created
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
identifier
any

Master Version Specific Identifier

period
any

Time of service that is being documented
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

When used for searching for CCD documents (type=http://loinc.org|34133-9 OR type=34133-9), a subset of the FHIR specification is allowed:

  1. period={qualifier}{date} Qualifier: gt (greater than), lt (less than), ge (greater than or equal to), le (less than or equal to)
  2. period={date} Inferred qualifier of eq (equals)
  3. period={qualifier}{date}&period={qualifier}{date} Qualifier: one gt and one lt Date formats: yyyy-MM-dd
type
any

Kind of document (LOINC if possible)

lastUpdated
any
versionId
any
patient
any

Who/what is the subject of the document

tag
any
_id
any

The ID of the resource

category
any

Categorization of document
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
status
any

current | superseded | entered-in-error
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read Encounter instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Encounter instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

A date within the period the Encounter lasted

identifier
any

Identifier(s) by which this encounter is known

type
any

Specific type of encounter

lastUpdated
any
versionId
any
patient
any

The patient or group present at the encounter

tag
any
_id
any

The ID of the resource

class
any

Classification of patient encounter
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
status
any

planned | arrived | triaged | in-progress | onleave | finished | cancelled +
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Encounter instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

A date within the period the Encounter lasted

identifier
any

Identifier(s) by which this encounter is known

type
any

Specific type of encounter

lastUpdated
any
versionId
any
patient
any

The patient or group present at the encounter

tag
any
_id
any

The ID of the resource

class
any

Classification of patient encounter
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
status
any

planned | arrived | triaged | in-progress | onleave | finished | cancelled +
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read Goal instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Goal instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

External Ids for this goal

lastUpdated
any
versionId
any
lifecycle-status
any

proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
patient
any

Who this goal is intended for

tag
any
target-date
any

Reach goal on or before
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Goal instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

External Ids for this goal

lastUpdated
any
versionId
any
lifecycle-status
any

proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
patient
any

Who this goal is intended for

tag
any
target-date
any

Reach goal on or before
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

Group

The Group FHIR resource type
Base profile: http://hl7.org/fhir/R4/group.html

read-instance: Read Group instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Group instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
actual
any

Descriptive or actual

identifier
any

Unique id

managing-entity
any

Entity that is the custodian of the Group's definition

code
any

The kind of resources contained

type
any

The type of resources the group contains

characteristic
any

Kind of characteristic

lastUpdated
any
security
any
versionId
any
member
any

Reference to the group member

exclude
any

Group includes or excludes

tag
any
value
any

Value held by characteristic

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

create-type: Create a new Group instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

Request Body schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Request samples

Content type
"{\n \"resourceType\": \"Group\"\n}"

Response samples

Content type
null

search-type: Search for Group instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
actual
any

Descriptive or actual

identifier
any

Unique id

managing-entity
any

Entity that is the custodian of the Group's definition

code
any

The kind of resources contained

type
any

The type of resources the group contains

characteristic
any

Kind of characteristic

lastUpdated
any
security
any
versionId
any
member
any

Reference to the group member

exclude
any

Group includes or excludes

tag
any
value
any

Value held by characteristic

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

/{tenantId}/Group/{id}/$export

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

query Parameters
_outputFormat
any
_type
any
_since
any
_typeFilter
any
_typePostFetchFilterUrl
any
_exportId
any
_mdm
any
patient
any

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

/{tenantId}/Group/{id}/$export

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Request Body schema: application/fhir+json
object (FHIR Resource)

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Request samples

Content type
application/fhir+json
"{\n \"resourceType\": \"Parameters\",\n \"parameter\": [ {\n \"name\": \"_outputFormat\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_type\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_since\"\n }, {\n \"name\": \"_typeFilter\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_typePostFetchFilterUrl\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_exportId\",\n \"valueString\": \"example\"\n }, {\n \"name\": \"_mdm\",\n \"valueBoolean\": false\n }, {\n \"name\": \"patient\",\n \"valueString\": \"example\"\n } ]\n}"

Response samples

Content type
null

read-instance: Read Immunization instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Immunization instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

Vaccination (non)-Administration Date

identifier
any

Business identifier

lastUpdated
any
versionId
any
patient
any

The patient for the vaccination record

tag
any
status
any

Immunization event status
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Immunization instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

Vaccination (non)-Administration Date

identifier
any

Business identifier

lastUpdated
any
versionId
any
patient
any

The patient for the vaccination record

tag
any
status
any

Immunization event status
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read Location instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Location instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

An identifier for the location

address
any

A (part of the) address of the location
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
address-state
any

A state specified in an address
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
address-postalcode
any

A postal code specified in an address
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
versionId
any
name
any

A portion of the location's name or alias
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
tag
any
address-city
any

A city specified in an address
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Location instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

An identifier for the location

address
any

A (part of the) address of the location
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
address-state
any

A state specified in an address
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
address-postalcode
any

A postal code specified in an address
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
versionId
any
name
any

A portion of the location's name or alias
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
tag
any
address-city
any

A city specified in an address
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read Medication instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Medication instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

Returns medications with this external identifier

lastUpdated
any
versionId
any
tag
any

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Medication instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

Returns medications with this external identifier

lastUpdated
any
versionId
any
tag
any

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

MedicationRequest

read-instance: Read MedicationRequest instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for MedicationRequest instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

Return prescriptions with this external identifier

authoredon
any

Return prescriptions written on this date
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
medication
any

Return prescriptions for this medication reference

encounter
any

Return prescriptions with this encounter identifier
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
intent
any

Returns prescriptions with different intents
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
versionId
any
patient
any

Returns prescriptions for a specific patient

tag
any
status
any

Status of the prescription

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for MedicationRequest instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

Return prescriptions with this external identifier

authoredon
any

Return prescriptions written on this date
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
medication
any

Return prescriptions for this medication reference

encounter
any

Return prescriptions with this encounter identifier
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
intent
any

Returns prescriptions with different intents
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
versionId
any
patient
any

Returns prescriptions for a specific patient

tag
any
status
any

Status of the prescription

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read Observation instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Observation instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

Obtained date/time. If the obtained element is a period, a date that falls in the period

identifier
any

The unique id for a particular observation

code
any

The code of the observation type

lastUpdated
any
versionId
any
patient
any

The subject that the observation is about (if patient)

tag
any
category
any

The classification of the type of observation
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
status
any

The status of the observation
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Observation instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

Obtained date/time. If the obtained element is a period, a date that falls in the period

identifier
any

The unique id for a particular observation

code
any

The code of the observation type

lastUpdated
any
versionId
any
patient
any

The subject that the observation is about (if patient)

tag
any
category
any

The classification of the type of observation
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
status
any

The status of the observation
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read Organization instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Organization instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

A portion of the organization's identifier
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
address
any

A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
versionId
any
name
any

A portion of the organization's name or alias
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
tag
any

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Organization instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

A portion of the organization's identifier
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
address
any

A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
versionId
any
name
any

A portion of the organization's name or alias
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
tag
any

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read Patient instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Patient instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

A patient identifier
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
given
any

A portion of the given name of the patient

birthdate
any

The patient's date of birth

gender
any

Gender of the patient

general-practitioner
any

Patient's nominated general practitioner, not the organization that manages the record

lastUpdated
any
versionId
any
organization
any

The organization that is the custodian of the patient record

name
any

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
tag
any
_id
any

The ID of the resource

family
any

A portion of the family name of the patient

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Patient instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

A patient identifier
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
given
any

A portion of the given name of the patient

birthdate
any

The patient's date of birth

gender
any

Gender of the patient

general-practitioner
any

Patient's nominated general practitioner, not the organization that manages the record

lastUpdated
any
versionId
any
organization
any

The organization that is the custodian of the patient record

name
any

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
tag
any
_id
any

The ID of the resource

family
any

A portion of the family name of the patient

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read Practitioner instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Practitioner instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

A practitioner's Identifier
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
versionId
any
name
any

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
tag
any
_id
any

The ID of the resource

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Practitioner instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
identifier
any

A practitioner's Identifier
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
lastUpdated
any
versionId
any
name
any

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain
tag
any
_id
any

The ID of the resource

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read Procedure instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Procedure instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

When the procedure was performed

identifier
any

A unique identifier for a procedure

code
any

A code to identify a procedure

lastUpdated
any
versionId
any
patient
any

Search by subject - a patient

tag
any
status
any

preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Procedure instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
date
any

When the procedure was performed

identifier
any

A unique identifier for a procedure

code
any

A code to identify a procedure

lastUpdated
any
versionId
any
patient
any

Search by subject - a patient

tag
any
status
any

preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
NOTE: This US Core SearchParameter definition extends the usage context of capabilitystatement-expectation extension to formally express implementer conformance expectations for these elements:

  • multipleAnd
  • multipleOr
  • comparator
  • modifier
  • chain

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

read-instance: Read Provenance instance

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

id
required
string >= 1
Example: 123

The resource ID

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Provenance instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
target
any

Target Reference(s) (usually version specific)

lastUpdated
any
versionId
any
patient
any

Target Reference(s) (usually version specific)

tag
any

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null

search-type: Search for Provenance instances

This is a search type

path Parameters
tenantId
required
string >= 1
Example: DEFAULT

The name of the tenant to target

query Parameters
target
any

Target Reference(s) (usually version specific)

lastUpdated
any
versionId
any
patient
any

Target Reference(s) (usually version specific)

tag
any

Responses

Response Schema:
object (FHIR-JSON-RESOURCE)

A FHIR resource

Response samples

Content type
null