Erika (v1)

Download OpenAPI specification:Download

Overview

Root URL

Production root URL: https://wc.praxisclouds.net/Erika/api/v1

Production documentation URL: https://www.praxisemr.com/applicationaccess/api/help/

To interact with the API, the client application must comply with the following standards:

US Core 3.1.1 / USCDI v1

Link: http://www.hl7.org/fhir/us/core/STU3.1.1

SMART App Launch 1.0.0

Link: https://hl7.org/fhir/smart-app-launch/1.0.0/

Bulk Data 1.0.1

Link: http://hl7.org/fhir/uv/bulkdata/STU1.0.1/

There are no technical requirements for an application to be registered in the authorization server.

Terms of Use: https://www.praxisemr.com/application-access-terms-of-use.html

AllData

Returns patient's CDA

Returns the patient's CDA.

path Parameters

patientId

required

integer <int32>

Responses

Response samples

200

Content type

text/plain

No sample

AllergyIntolerance

AllergyIntolerance by Id

Returns a single AllergyIntolerance resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "AllergyIntolerance",
"id": "number",
"clinicalStatus": {"coding": [{"system": "string",
"code": "string"
}
]
},
"verificationStatus": {"coding": [{"system": "string",
"code": "string"
}
]
},
"code": {"coding": [{"system": "string",
"code": "number",
"display": "string"
},
{"system": "string",
"code": "string",
"display": "string"
}
],
"text": "string"
},
"patient": {"reference": "string"
},
"onsetDateTime": "string",
"reaction": [{"manifestation": [{"coding": [{"system": "string",
"code": "string",
"display": "string"
}
]
}
],
"severity": "string"
}
]
}

AllergyIntolerance by parameters

Returns a Bundle resource which includes a list of AllergyIntolerance resources by parameters.

query Parameters

patient	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

AllergyIntolerance by parameters

Returns a Bundle resource which includes a list of AllergyIntolerance resources by parameters.

Request Body schema: multipart/form-data

patient	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Bulk

Kick-Off

FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients in specified Group

path Parameters

id

required

string

query Parameters

_outputFormat	string
_since	string
_type	string

Responses

Response samples

200

Content type

text/plain

No sample

StatusContentLocation

Check the status URL provided in the Content-Location header of the Kick Off endpoint.

path Parameters

id

required

string

Responses

Response samples

200

Content type

text/plain

No sample

DeleteContentLocation

Send a delete request to the URL provided in the Content-Location header of the Kick Off endpoint to cancel the request.

path Parameters

id

required

string

Responses

Response samples

200

Content type

text/plain

No sample

FileRequest

Download file of bulk data generated.

path Parameters

id required	string
fileName required	string

Responses

Response samples

200

Content type

text/plain

{
  "transactionTime": "11/25/2022 11:38:40 AM",
  "request": "https://wc.praxisclouds.net/api/v1/Group/ABC/$export",
  "requiresAccessToken": true,
  "output": [
    {
      "type": "Provenance",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/03fd61fd-6e39-4b84-bb77-179571e5ff59.ndjson"
    },
    {
      "type": "AllergyIntolerance",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/135450f7-0c63-4788-8a41-ecd7982736e7.ndjson"
    },
    {
      "type": "DiagnosticReport",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/179fb702-2b42-44d8-b85c-9290ac808d9e.ndjson"
    },
    {
      "type": "Practitioner",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/1f1f0b23-927d-4ce2-9d77-5e068b45a166.ndjson"
    },
    {
      "type": "Goal",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/3492f229-aece-416c-8536-2d2759e52e21.ndjson"
    },
    {
      "type": "CareTeam",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/44ac155e-cf0c-4cfd-8457-e6ebca22f30d.ndjson"
    },
    {
      "type": "DocumentReference",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/4b4765ef-ac03-4011-a9ef-336f28a39248.ndjson"
    },
    {
      "type": "MedicationRequest",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/546c6d00-1c98-4992-ba9f-59cf2cca99e8.ndjson"
    },
    {
      "type": "Device",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/6d17aaf7-4301-499c-bc62-05f48f93e1dd.ndjson"
    },
    {
      "type": "Medication",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/6d1cd286-8228-4cd5-9e45-4f0fbcbd58bd.ndjson"
    },
    {
      "type": "Procedure",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/73858f56-29c5-4704-8bf6-418bb0ffa1f5.ndjson"
    },
    {
      "type": "Encounter",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/7ee698b9-b373-4375-85d4-e63c6a8fb5dd.ndjson"
    },
    {
      "type": "CarePlan",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/88b9a72b-f11b-464c-8435-73e300fbe8be.ndjson"
    },
    {
      "type": "Patient",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/c3f424a3-eb8c-4e3f-a3c5-cecc0cebd607.ndjson"
    },
    {
      "type": "Observation",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/cb26a7a2-f90c-4037-ad8d-b817480c3bc5.ndjson"
    },
    {
      "type": "Location",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/d3578de8-35a4-4305-b95a-5cef0c3a77de.ndjson"
    },
    {
      "type": "Immunization",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/d7c7f542-749e-4ce3-8df2-674f149da1cd.ndjson"
    },
    {
      "type": "Organization",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/e1bb51ca-84f6-4a35-86e9-993f5887a8d3.ndjson"
    },
    {
      "type": "Condition",
      "url": "https://wc.praxisclouds.net/Erika/api/v1/Download/310b60f3-90e2-4976-81e7-591747b665c6/fc3a57bf-6997-4695-ba31-1fc8911fedfa.ndjson"
    }
  ],
  "error": null
}

CarePlan

CarePlan by Id

Returns a single CarePlan resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "CarePlan",
"id": "number",
"text": {"status": "string",
"div": "string"
},
"status": "string",
"intent": "string",
"category": [{"coding": [{"system": "string",
"code": "string"
}
]
}
],
"subject": {"reference": "string",
"identifier": {"value": "string"
}
}
}

CarePlan by parameters

Returns a Bundle resource which includes a list of CarePlan resources by parameters.

query Parameters

patient	string
_revinclude	string
category	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

CarePlan by parameters

Returns a Bundle resource which includes a list of CarePlan resources by parameters.

Request Body schema: multipart/form-data

patient	string
_revinclude	string
category	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

CareTeam

CareTeam by Id

Returns a single CareTeam resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "CareTeam",
"id": "number",
"status": "string",
"subject": {"reference": "string"
},
"participant": [{"role": [{"coding": [{"system": "string",
"code": "string"
}
]
}
],
"member": {"reference": "string",
"display": "string"
}
},
{"role": [{"coding": [{"system": "string",
"code": "string"
}
]
}
],
"member": {"reference": "string",
"display": "string"
}
},
{"role": [{"coding": [{"system": "string",
"code": "string"
}
]
}
],
"member": {"reference": "string",
"display": "string"
}
},
{"role": [{"coding": [{"system": "string",
"code": "string"
}
]
}
],
"member": {"reference": "string",
"display": "string"
}
},
{"role": [{"coding": [{"system": "string",
"code": "string"
}
]
}
],
"member": {"reference": "string",
"display": "string"
}
},
{"role": [{"coding": [{"system": "string",
"code": "string"
}
]
}
],
"member": {"reference": "string",
"display": "string"
}
},
{"role": [{"coding": [{"system": "string",
"code": "string"
}
]
}
],
"member": {"reference": "string",
"display": "string"
}
}
]
}

CareTeam by parameters

Returns a Bundle resource which includes a list of CareTeam resources by parameters.

query Parameters

patient	string
status	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

CareTeam by parameters

Returns a Bundle resource which includes a list of CareTeam resources by parameters.

Request Body schema: multipart/form-data

patient	string
status	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Condition

Condition by Id

Returns a single Condition resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Condition",
"id": "number",
"clinicalStatus": {"coding": [{"system": "string",
"code": "string",
"display": "string"
}
],
"text": "string"
},
"verificationStatus": {"coding": [{"system": "string",
"code": "string"
}
]
},
"category": [{"extension": [{"url": "string",
"valueCode": "string"
}
]
},
{"coding": [{"system": "string",
"code": "string"
}
]
}
],
"code": {"coding": [{"system": "string"
},
{"system": "string",
"code": "string",
"display": "string"
}
]
},
"subject": {"reference": "string"
}
}

Condition by parameters

Returns a Bundle resource which includes a list of Condition resources by parameters.

query Parameters

patient	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Condition by parameters

Returns a Bundle resource which includes a list of Condition resources by parameters.

Request Body schema: multipart/form-data

patient	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Device

Device by Id

Returns a single Device resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Device",
"id": "number",
"udiCarrier": [{"deviceIdentifier": "string",
"carrierHRF": "string"
}
],
"distinctIdentifier": "string",
"manufactureDate": "string",
"expirationDate": "string",
"lotNumber": "string",
"serialNumber": "string",
"type": {"coding": [{"system": "string",
"code": "string",
"display": "string"
}
]
},
"patient": {"reference": "string"
}
}

Device by parameters

Returns a Bundle resource which includes a list of Device resources by parameters.

query Parameters

patient	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Device by parameters

Returns a Bundle resource which includes a list of Device resources by parameters.

Request Body schema: multipart/form-data

patient	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

DiagnosticReport

DiagnosticReport by Id

Returns a single DiagnosticReport resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "DiagnosticReport",
"id": "number",
"status": "string",
"category": [{"coding": [{"system": "string",
"code": "string",
"display": "string"
}
],
"text": "string"
}
],
"code": {"coding": [{"system": "string",
"code": "string",
"display": "string"
}
],
"text": "string"
},
"subject": {"reference": "string"
},
"encounter": {"reference": "string"
},
"effectiveDateTime": "string",
"issued": "string",
"performer": [{"reference": "string",
"display": "string"
}
],
"presentedForm": [{"contentType": "string",
"data": "string"
}
]
}

DiagnosticReport by parameters

Returns a Bundle resource which includes a list of DiagnosticReport resources by parameters.

query Parameters

patient	string
code	string
category	string
date	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

DiagnosticReport by parameters

Returns a Bundle resource which includes a list of DiagnosticReport resources by parameters.

Request Body schema: multipart/form-data

patient	string
code	string
category	string
date	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

DocumentReference

DiagnosticReport by Id

Returns a single DocumentReference resource by id.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "DocumentReference",
"id": "number",
"identifier": [{"value": "string"
}
],
"status": "string",
"type": {"coding": [{"system": "string",
"code": "string",
"display": "string"
}
],
"text": "string"
},
"category": [{"coding": [{"system": "string",
"code": "string",
"display": "string"
}
]
}
],
"subject": {"reference": "string"
},
"date": "string",
"author": [{"reference": "string",
"display": "string"
}
],
"custodian": {"reference": "string",
"display": "string"
},
"content": [{"attachment": {"contentType": "string",
"data": "string"
},
"format": {"system": "string",
"code": "string"
}
}
],
"context": {"encounter": [{"reference": "string"
}
],
"period": {"start": "string"
}
}
}

DiagnosticReport by parameters

Returns a Bundle resource which includes a list of DocumentReference resources by parameters.

query Parameters

patient	string
_id	string
type	string
category	string
date	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

DiagnosticReport by parameters

Returns a Bundle resource which includes a list of DocumentReference resources by parameters.

Request Body schema: multipart/form-data

patient	string
_id	string
type	string
category	string
date	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Encounter

Encounter by Id

Returns a single Encounter resource by id.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Encounter",
"id": "number",
"identifier": [{"system": "string",
"value": "string"
}
],
"status": "string",
"class": {"system": "string",
"code": "string"
},
"type": [{"coding": [{"system": "string",
"code": "string"
}
],
"text": "string"
}
],
"subject": {"reference": "string"
},
"participant": [{"type": [{"coding": [{"system": "string",
"code": "string",
"display": "string"
}
]
}
],
"period": {"start": "string"
},
"individual": {"reference": "string"
}
}
],
"period": {"start": "string"
},
"reasonCode": [{"coding": [{"system": "string",
"code": "string"
}
],
"text": "string"
}
],
"hospitalization": {"dischargeDisposition": {"coding": [{"system": "string",
"code": "string"
}
]
}
},
"location": [{"location": {"reference": "string",
"display": "string"
}
}
]
}

Encounter by parameters

Returns a Bundle resource which includes a list of Encounter resources by parameters.

query Parameters

_id	string
patient	string
date	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Encounter by parameters

Returns a Bundle resource which includes a list of Encounter resources by parameters.

Request Body schema: multipart/form-data

_id	string
patient	string
date	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Goal

Goal by Id

Returns a single Goal resource by id.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Goal",
"id": "number",
"lifecycleStatus": "string",
"description": {"text": "string"
},
"subject": {"reference": "string"
},
"startDate": "string",
"target": [{"dueDate": "string"
}
]
}

Goal by parameters

Returns a Bundle resource which includes a list of Goal resources by parameters.

query Parameters

_id	string
patient	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Goal by parameters

Returns a Bundle resource which includes a list of Goal resources by parameters.

Request Body schema: multipart/form-data

_id	string
patient	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Identity

/api/v1/Identity

Responses

Immunization

Immunization by Id

Returns a single Immunization resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Immunization",
"id": "number",
"status": "string",
"statusReason": {"text": "string"
},
"vaccineCode": {"coding": [{"system": "string",
"code": "number"
}
],
"text": "string"
},
"patient": {"reference": "string",
"display": "string"
},
"occurrenceDateTime": "string",
"primarySource": false
}

Immunization by parameters

Returns a Bundle resource which includes a list of Immunization resources by parameters.

query Parameters

patient	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Immunization by parameters

Returns a Bundle resource which includes a list of Immunization resources by parameters.

Request Body schema: multipart/form-data

patient	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Location

Location by Id

Returns a single Location resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Location",
"id": "number",
"status": "string",
"name": "string",
"telecom": [{"system": "string",
"value": "string"
}
],
"address": {"line": ["string",
"string"
],
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"managingOrganization": {"reference": "string",
"display": "string"
}
}

Location by parameters

Returns a Bundle resource which includes a list of Location resources by parameters.

query Parameters

name	string
address	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Location by parameters

Returns a Bundle resource which includes a list of Location resources by parameters.

Request Body schema: multipart/form-data

name	string
address	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Medication

Medication by Id

Returns a single Medication resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

text/plain

{
  "resourceType": "Medication",
  "id": "number",
  "code": {
    "coding": [
      {
        "system": "string",
        "code": "number",
        "display": "string"
      },
      {
        "system": "string",
        "code": "number"
      }
    ]
  }
}

Medication by parameters

Returns a Bundle resource which includes a list of Medication resources by parameters.

query Parameters

patient

string

Responses

Response samples

200

Content type

text/plain

{
  "resourceType": "Bundle",
  "id": "string",
  "type": "string",
  "total": "number",
  "link": [
    {
      "relation": "string",
      "url": "URL"
    }
  ]
}

MedicationRequest

MedicationRequest by Id

Returns a single MedicationRequest resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "MedicationRequest",
"id": "number",
"status": "string",
"intent": "string",
"reportedBoolean": true,
"medicationReference": {"reference": "string"
},
"subject": {"reference": "string"
},
"encounter": {"reference": "string"
},
"authoredOn": "string",
"requester": {"reference": "string",
"display": "string"
},
"dosageInstruction": [{"text": "string",
"timing": {"code": {"text": "string"
}
}
}
]
}

MedicationRequest by parameters

Returns a Bundle resource which includes a list of MedicationRequest resources by parameters.

query Parameters

patient	string
intent	string
status	string
_include	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

MedicationRequest by parameters

Returns a Bundle resource which includes a list of MedicationRequest resources by parameters.

Request Body schema: multipart/form-data

patient	string
intent	string
status	string
_include	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Metadata

CapabilityStatement

Returns a single CapabilityStatement resource

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "CapabilityStatement",
"url": "string",
"name": "string",
"status": "string",
"date": "string",
"publisher": "string",
"description": "string",
"kind": "string",
"instantiates": ["string"
],
"implementation": {"description": "string",
"url": "string"
},
"fhirVersion": "string",
"format": ["string",
"string"
],
"patchFormat": ["string"
],
"rest": [{"mode": "string",
"documentation": "string",
"security": {"extension": [{"url": "string",
"extension": [{"url": "string",
"valueUri": "string"
}
]
}
],
"cors": "string",
"service": [{"coding": [{"system": "string",
"code": "string",
"display": "string"
}
],
"text": "string"
}
]
},
"resource": [{"type": "string",
"supportedProfile": ["string"
],
"interaction": [{"code": "string"
}
],
"searchRevInclude": ["string"
],
"searchParam": [{"name": "string",
"type": "string"
}
]
},
{"type": "string",
"operation": [{"extension": [{"url": "string",
"valueCode": "string"
}
],
"name": "string",
"definition": "string"
}
]
}
],
"operation": [{"extension": [{"url": "string",
"valueCode": "string"
}
],
"name": "export",
"definition": "string"
},
{"name": "string",
"definition": "string"
}
]
}
],
"document": [{"mode": "string",
"documentation": "string",
"profile": "string"
}
]
}

Observation

Observation by Id

Returns a single Observation resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "string",
"id": "number",
"status": "string",
"category": [{"coding": [{"system": "string",
"code": "string",
"display": "string"
}
],
"text": "string"
}
],
"code": {"coding": [{"system": "string",
"code": "number"
}
],
"text": "string"
},
"subject": {"reference": "string"
},
"issued": "string",
"valueCodeableConcept": {"coding": [{"system": "string",
"code": "string",
"display": "string"
}
]
}
}

Observation by parameters

Returns a Bundle resource which includes a list of Observation resources by parameters.

query Parameters

_id	string
patient	string
code	string
category	string
date	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Observation by parameters

Returns a Bundle resource which includes a list of Observation resources by parameters.

Request Body schema: multipart/form-data

_id	string
patient	string
code	string
category	string
date	string
_revinclude	string

Responses

Response samples

200

Content type

text/plain

{
  "resourceType": "Bundle",
  "id": "string",
  "type": "string",
  "total": "number",
  "link": [
    {
      "relation": "string",
      "url": "URL"
    }
  ]
}

Organization

Organization by Id

Returns a single Organization resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Organization",
"id": "129",
"identifier": [{"system": "string",
"value": "string"
}
],
"active": true,
"name": "string",
"telecom": [{"system": "string",
"value": "string"
}
],
"address": [{"line": ["string",
"string"
],
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
}
]
}

Organization by parameters

Returns a Bundle resource which includes a list of Organization resources by parameters.

query Parameters

name	string
address	string
name_modifier	string
address_modifier	string
name:contains	string
name:exact	string
address:contains	string
address:exact	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Organization by parameters

Returns a Bundle resource which includes a list of Organization resources by parameters.

Request Body schema: multipart/form-data

name	string
address	string
name_modifier	string
address_modifier	string
name:contains	string
name:exact	string
address:contains	string
address:exact	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Patient

Patient by Id

Returns a single Patient resource by id.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/fhir+json

{"fullUrl": "string",
"resource": {"resourceType": "Patient",
"id": "example-number",
"extension": [{"extension": [{"url": "string",
"valueCoding": {"system": "string",
"code": "number",
"display": "string"
}
},
{"url": "string",
"valueString": "string"
}
],
"url": "string"
},
{"extension": [{"url": "string",
"valueCoding": {"system": "string",
"code": "number",
"display": "string"
}
},
{"url": "text",
"valueString": "-"
}
],
"url": "string"
},
{"url": "string",
"valueCode": "string"
}
],
"identifier": [{"system": "string",
"value": "number"
}
],
"name": [{"use": "string",
"family": "string",
"given": ["string",
"string"
]
},
{"use": "string",
"family": "string",
"given": ["Alicia"
]
}
],
"telecom": [{"system": "string",
"value": "string",
"use": "string"
},
{"system": "string",
"value": "string",
"use": "string"
}
],
"gender": "string",
"birthDate": "string",
"address": [{"use": "string",
"text": "string",
"line": ["string",
"string"
],
"city": "string",
"postalCode": "string",
"period": {"start": "number"
}
}
],
"communication": [{"language": {"coding": [{"code": "string"
}
]
}
}
]
}
}

Patient by Parameters

Returns a Bundle resource which includes a list of Patients resources by parameters.

query Parameters

_id	string
identifier	string
name	string
birthdate	string
gender	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Patient by Parameters

Returns a Bundle resource which includes a list of Patients resources by parameters.

Request Body schema: multipart/form-data

_id	string
identifier	string
name	string
birthdate	string
gender	string
_revinclude	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Practitioner

Practitioner by Id

Returns a single Pratitioner resource by id.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Practitioner",
"id": "number",
"identifier": [{"system": "url",
"value": "number"
}
],
"name": [{"family": "string"
}
]
}

Practitioner by parameters

Returns a Bundle resource which includes a list of Practitioner resources by parameters.

query Parameters

name	string
identifier	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

PractitionerRole

PractitionerRole by Id

Returns a single PractitionerRole resource by id.

path Parameters

id

required

string

Responses

Response samples

200

Content type

text/plain

{
  "resourceType": "PractitionerRole",
  "id": "number",
  "practitioner": {
    "reference": "string",
    "display": "string"
  },
  "organization": {
    "reference": "string",
    "display": "string"
  },
  "code": [
    {
      "coding": [
        {
          "system": "url",
          "code": "string"
        }
      ]
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "system": "url",
          "code": "string"
        }
      ]
    }
  ],
  "location": [
    {
      "reference": "url",
      "display": "string"
    }
  ],
  "telecom": [
    {
      "system": "string",
      "value": "string"
    }
  ],
  "endpoint": [
    {
      "display": "string"
    }
  ]
}

PractitionerRole by parameters

Returns a Bundle resource which includes a list of PractitionerRole resources by parameters.

query Parameters

specialty	string
practitioner	string
practitioner.name	string
practitioner.identifier	string
_include	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

/api/v1/PractitionerRole

query Parameters

_include

string

Request Body schema: multipart/form-data

specialty	string
practitioner	string
practitioner.name	string
practitioner.identifier	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Procedure

Procedure by Id

Returns a single Procedure resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Procedure",
"id": "number",
"status": "string",
"code": {"coding": [{"system": "string",
"code": "number",
"display": "string"
}
]
},
"subject": {"reference": "string"
},
"performedDateTime": "string"
}

Procedure by Parameters

Returns a Bundle resource which includes a list of Procedure resources by parameters.

query Parameters

patient	string
_revinclude	string
date	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Procedure by parameters

Returns a Bundle resource which includes a list of Procedure resources by parameters.

query Parameters

patient	string
_revinclude	string
date	string

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Bundle",
"id": "string",
"type": "string",
"total": "number",
"link": [{"relation": "string",
"url": "URL"
}
]
}

Provenance

Provenance by Id

Returns a single Provenance resource by id.

path Parameters

id

required

integer <int32>

Responses

Response samples

200

Content type

application/fhir+json

{"resourceType": "Provenance",
"id": "number",
"target": [{"reference": "string"
},
{"reference": "string"
}
],
"recorded": "string",
"agent": [{"type": {"coding": [{"system": "url",
"code": "string",
"display": "string"
}
]
},
"who": {"reference": "string",
"display": "string"
},
"onBehalfOf": {"reference": "string",
"display": "string"
}
},
{"type": {"coding": [{"system": "url",
"code": "string",
"display": "string"
}
]
},
"who": {"reference": "string",
"display": "string"
},
"onBehalfOf": {"reference": "string",
"display": "string"
}
}
]
}

WellKnown

Well Known SMART Configuration

Returns a resource with information about the API

Responses

Response samples

200

Content type

text/plain

{
  "authorization_endpoint": "string",
  "token_endpoint": "string",
  "introspection_endpoint": "string",
  "revocation_endpoint": "string",
  "jwks_uri": "string",
  "token_endpoint_auth_methods_supported": [
    "string"
  ],
  "token_endpoint_auth_signing_alg_values_supported": [
    "string"
  ],
  "scopes_supported": [
    "string"
  ],
  "capabilities": [
    "string"
  ]
}