FHIR API
All the API calls (that contain medical data) meet FHIR standard.
We developed a FHIR API layer for communication with Openemr database.
The API is written in FHIR V4 standard.
Currently we don't provide full FHIR api, here detailed documentation of all the available calls.
Patient
Supported Requests
- [x] read
- [x] search
- [x] create
- [x] update
- [ ] delete
- [x] patch (only replace)
Supported Resource Properties
{
"id":1,
"resourceType":"Patient",
"identifier": [
{
"type": {
"coding": [
{
"code": "idtype_3"
}
],
"text": "idtype_3"
},
"value": "43534535345"
}
],
"name":[
{
"family":"ראשון",
"given":[
"בדיקה"
]
}
],
"telecom":[
{
"system":"email",
"value":"amiel@gmail.com"
},
{
"system":"phone",
"value":"064525252",
"use":"home"
},
{
"system":"phone",
"value":"0525112396",
"use":"mobile"
}
],
"gender":"male",
"birthDate":"2015-05-04",
"deceasedBoolean":false,
"address":[
{
"type":"both",
"line":[
"3",
"34"
],
"city":"city_3000",
"postalCode":"4517200",
"country":"country_254"
}
],
"managingOrganization":{
"reference":"Organization/6"
}
}
Supported Operators
None
Supported General Search Parameters
| Parameter | Valid Values |
|---|---|
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | exact, contains | ||
| identifier | exact, contains,of-type | "system|code|identifier" * | |
| mobile | exact, contains | ||
| organization | |||
| name | exact, contains |
* example :identifier:of-type=|idtype_3|1111111
Appointment
Supported Requests
- [x] read
- [x] search
- [x] create
- [x] update
- [ ] delete
Supported Resource Properties
{
"id": 4,
"resourceType": "Appointment",
"status": "noshow",
"serviceType": [
{
"coding": [
{
"code": "3"
}
],
"text": "X-ray"
}
],
"reasonCode": [
{
"coding": [
{
"code": "1"
}
],
"text": "shoulder"
},
{
"coding": [
{
"code": "2"
}
],
"text": "ankle"
}
],
"priority": "1",
"description": "זה תיאור מגניב",
"start": "2020-01-28T09:15:00.000Z",
"end": "2020-01-28T09:30:00.000Z",
"minutesDuration": "15",
"comment": "66666666666",
"participant": [
{
"actor": {
"reference": "Patient/1"
}
},
{
"actor": {
"reference": "HealthcareService/2"
}
}
]
}
Supported Operators
None
Supported General Search Parameters
| Parameter | Valid Values |
|---|---|
| _include | Appointment:patient |
| _sort | date, priority, service-type ** |
| _summary | count |
** Can be used separately or combined together using commas
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | |||
| date | eq, ge, le | ||
| status | not | ||
| actor:HealthcareService.organization | |||
| service-type |
Examples
Search request:
GET /apis/fhir/v4/Appointment?date=ge2019-01-16&date=le2020-01-30&_include=Appointment:patient
Encounter
Supported Requests
- [x] read
- [x] search
- [x] create
- [x] update
- [x] delete
- [x] patch
Supported Resource Properties
{
"id": "7",
"resourceType": "Encounter",
"extension": [
{
"valueString": "Life is peaceful there",
"url": "http://clinikal/extensions/encounter/reasonCodesDetail"
},
{
"valueString": "Go West ",
"url": "http://clinikal/extensions/encounter/arrivalWay"
},
{
"valueString": "waiting_for_nurse",
"url": "http://clinikal/extensions/encounter/secondaryStatus"
},
{
"valueDateTime": "2019-06-21T13:15:20.000Z",
"url": "http://clinikal/extensions/encounter/statusUpdateDate"
}
],
"status": "planned",
"serviceType": {
"coding": [
{
"code": "1"
}
],
"text": "Ultrasound"
},
"priority": {
"coding": [
{
"code": "0"
}
]
},
"subject": {
"reference": "Patient/1"
},
"participant": [
{
"individual": {
"reference": "Practitioner/1"
}
},
{
"individual": {
"reference": "RelatedPerson/4"
}
}
],
"appointment": [
{
"reference": "Appointment/1"
}
],
"period": {
"start": "2020-03-08T00:00:00.000Z"
},
"reasonCode": [
{
"coding": [
{
"code": "5"
}
],
"text": "Upper Abdomen"
}
],
"serviceProvider": {
"reference": "Organization/2"
}
}
Supported Operators
None
Supported General Search Parameters
| Parameter | Valid Values |
|---|---|
| _include | Encounter:patient |
| _sort | date, priority, service-type ** |
| _summary | count |
** Can be used separately or combined together using commas
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | |||
| date | eq, ge, le | ||
| status | V | ||
| appointment | |||
| patient | |||
| service-provider | |||
| service-type | |||
| arrival_way | *1 | ||
| reason_codes_details | *1 | ||
| all-statuses | *2 |
1 search is by part of string (does not support exact) 2 search in : Encounter.status OR Encounter.extension.valueString (WHERE url "http://clinikal/extensions/encounter/secondaryStatus")
Examples
Search request:
GET /apis/fhir/v4/Encounter/1
GET /apis/fhir/v4/Encounter (all)
GET /apis/fhir/v4/Encounter?_id=8
GET /apis/fhir/v4/Encounter?_id=8&status=planned&status=in progress (or operator)
GET /apis/fhir/v4/HealthcareService?appointment=5&patient=78
GET /apis/fhir/v4/Encounter?date=gt2020-02-09
Practitioner
Supported Requests
- [x] read
- [x] search
- [ ] create
- [ ] update
- [ ] delete
Supported Resource Properties
{
"id":4,
"resourceType":"Practitioner",
"identifier":[
{
"value":"039664776"
}
],
"active":1,
"name":[
{
"family":"yosi",
"given":[
"cohen",
"motek"
]
}
]
}
Supported Operators
None
Supported General Search Parameters
| Parameter | Valid Values |
|---|---|
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | |||
| given | |||
| family |
Examples
Read request:
GET /apis/fhir/v4/Practitioner/:id
Search requests:
GET /apis/fhir/v4/Practitioner?name=yosi&active=1
Organization
Supported Requests
- [X] read
- [X] search
- [ ] create
- [ ] update
- [ ] delete
Supported Resource Properties
{
"resourceType":"Organization",
"id":4,
"name":"מחוז אשקלון",
"alias":[
null
],
"telecom":[
{
"system":"fax",
"value":"+972-546-837-767"
},
{
"system":"phone",
"value":"+972-546-837-766",
"use":"work"
}
],
"address":[
{
"line":[
"שד הפלי\"ם 15א"
],
"city":"חיפה",
"state":"32"
}
]
}
Supported Operators
None
Supported General Search Parameters
| Parameter | Valid Values |
|---|---|
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | |||
| name | |||
| active |
Examples
Read request:
GET /apis/fhir/v4/Organization/:id
Search requests:
GET /apis/fhir/v4/Organization (all)
GET /apis/fhir/v4/Organization?_id=8
GET /apis/fhir/v4/Organization?_id=8&active=1
GET /apis/fhir/v4/Organization?name=לשכת בריאות חיפה
GET /apis/fhir/v4/Organization?name=חיפה&active=1
HealthcareService
Supported Requests
- [x] read
- [x] search
- [ ] create
- [ ] update
- [ ] delete
Supported Resource Properties:
{
"id": 2,
"resourceType": "HealthcareService",
"active": 1,
"providedBy": {
"reference": "Organization/3",
"display": "Your Clinic Name Here"
},
"category": [
{
"coding": [
{
"code": "30"
}
],
"text": "Specialist Radiology/Imaging"
}
],
"type": [
{
"coding": [
{
"code": "1"
}
],
"text": "Ultrasound"
}
],
"name": "The Ultrasounders Inc.",
"comment": "only ultrasounds",
"extraDetails": "this can be in markdown",
"availableTime": [
{
"daysOfWeek": [
"mon",
"tue"
],
"allDay": 1
},
{
"daysOfWeek": [
"thu",
"fri"
],
"availableStartTime": "08:30:00",
"availableEndTime": "05:30:00"
}
],
"notAvailable": [
{
"during": {
"start": "2015-12-25T12:03:31.000Z",
"end": "2015-12-26T12:03:31.000Z"
}
},
{
"during": {
"start": "2016-01-01T12:03:31.000Z",
"end": "2016-01-01T12:03:31.000Z"
}
}
],
"availabilityExceptions": "Reduced capacity is available during the Christmas period"
}
Supported Operators
None
Supported General Search Parameters
| Parameter | Valid Values |
|---|---|
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | |||
| active | |||
| name | |||
| organization | |||
| service-type |
Examples
Read request:
GET /apis/fhir/v4/HealthcareService/:id
ValueSet
Supported Requests
- [x] read
- [ ] search
Supported Resource Properties:
{
"id": "reason_codes_5",
"resourceType": "ValueSet",
"title": "MRI Reason Codes",
"status": "active",
"expansion": {
"timestamp": "2020-02-19 06:07:24T18:07:24.000Z",
"contains": [
{
"system": "clinikal_reason_codes",
"code": "18",
"display": "Backbone"
},
{
"system": "clinikal_reason_codes",
"code": "19",
"display": "Brain"
}
]
}
}
Supported Operators
- $expand
Supported General Search Parameters
| Parameter | Valid Values |
|---|---|
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
Examples
Read request:
GET /apis/fhir/v4/ValueSet/:id/$expand
RelatedPerson
Supported Requests
- [x] read
- [x] search
- [x] create
- [x] update
- [ ] delete
- [x] patch
Supported Resource Properties:
{
"id": "1",
"resourceType": "RelatedPerson",
"identifier": [
{
"type": {
"coding": [
{
"code": "bobo"
}
]
},
"value": "1235698"
}
],
"active": true,
"patient": {
"reference": "Patient/1"
},
"relationship": [
{
"coding": [
{
"code": "OCVJO"
}
]
}
],
"name": [
{
"text": "idan the man"
}
],
"telecom": [
{
"system": "phone",
"value": "036495774",
"use": "home"
},
{
"system": "email",
"value": "bobo@gmail.com"
},
{
"system": "phone",
"value": "054480880",
"use": "mobile"
}
],
"gender": "male"
}
Supported Operators
None
Supported General Search Parameters
| Parameter | Valid Values |
|---|---|
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | |||
| identifier | |||
| active | |||
| patient | |||
| relationship | |||
| gender | |||
| name |
*name search by name (full name) is exact search unless a parameter is being used.
Examples
Read request:
GET /apis/fhir/v4/RelatedPerson/:id
DocumentReference
Supported Requests
- [x] read
- [x] search
- [x] create
- [ ] update
- [ ] delete
- [ ] patch
Supported Resource Properties:
{
"id": "5",
"resourceType": "DocumentReference",
"category": [
{
"coding": [
{
"code": "2",
"display": "EMedical Record"
}
]
}
],
"author": [
{
"reference": "Practitioner/1"
}
],
"content": [
{
"attachment": {
"contentType": "application/pdf",
"data": "fgsdFGSDER4543524ASDFSADFSDFSDAFSDF$@#FV$%TtvserTDFZSD", **
"url": "name_bla_bla"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/1"
}
],
"sourcePatientInfo": {
"reference": "Patient/1"
}
}
}
** In base64 format
Supported Operators
None
Supported General Search Parameters
| Parameter | Valid Values |
|---|---|
| _summary | true |
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | |||
| encounter | |||
| patient |
Examples
Read request:
GET /apis/fhir/v4/DocumentReference/:id
Questionnaire
Supported Requests
- [x] read
- [x] search
- [ ] create
- [ ] update
- [ ] delete
Supported Resource Properties
{
"id": "38",
"resourceType": "Questionnaire",
"name": "commitment_questionnaire",
"title": "Commitment questionnaire",
"status": "active",
"item": [
{
"linkId": "1",
"text": "Commitment number",
"type": "integer"
},
{
"linkId": "2",
"text": "Commitment date",
"type": "date"
}
]
}
Supported Operators
None
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| title | exact | ||
| status | exact | active | |
| name | exact |
QuestionnaireResponse
Supported Requests
- [x] read
- [x] search
- [x] create
- [x] update
- [ ] delete
Supported Resource Properties
{
"id": "61",
"resourceType": "QuestionnaireResponse",
"questionnaire": "Questionnaire/38",
"status": "in-progress",
"subject": {
"reference": "Patient/4"
},
"encounter": {
"reference": "Encounter/1"
},
"authored": "2020-03-24T12:21:21.000Z",
"author": {
"reference": "Practitioner/1"
},
"source": {
"reference": "Patient/4"
},
"item": [
{
"linkId": "1",
"text": "Commitment number",
"answer": [
{
"valueInteger": "11111111"
}
]
},
{
"linkId": "2",
"text": "Commitment date",
"answer": [
{
"valueDate": "03/01/1984"
}
]
}
]
}
Supported Operators
None
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | exact | ||
| status | exact | ||
| encounter | exact | ||
| questionnaire | |||
| subject | exact | ||
| author | exact | ||
| patient | exact |
condition
Supported Requests
- [x] read
- [x] search
- [x] create
- [x] update
- [ ] delete
Supported Resource Properties
{
"id": "1",
"resourceType": "Condition",
"clinicalStatus": {
"coding": [
{
"system": "http://clinikal/valueset/reaction/outcome",
"code": "0"
}
],
"text": "Unassigned"
},
"category": [
{
"coding": [
{
"system": "http://clinikal/condition/category/medical_problem",
"code": "asthma"
}
]
}
],
"code": {
"coding": [
{
"system": "http://clinikal/diagnosis/type/MOH_ICD10",
"code": "A159"
}
]
},
"subject": {
"reference": "Patient/1"
},
"encounter": {
"reference": "Encounter/1"
},
"onsetDateTime": "2020-05-01T11:12:15.000Z",
"abatementDateTime": "2020-05-25T11:12:15.000Z",
"recordedDate": "2020-05-25T15:35:27.000Z",
"recorder": {
"reference": "Practitioner/1"
},
"stage": [
{
"summary": {
"text": "bad asthma"
},
"type": {
"coding": [
{
"system": "http://clinikal/valueset/reaction/occurrence",
"code": "2"
}
],
"text": "frequency_1"
}
}
],
"evidence": [
{
"code": [
{
"coding": [
{
"system": "http://clinikal/valueset/reaction",
"code": "shortness_of_breath"
}
]
}
]
}
],
"note": [
{
"text": "bla bla"
}
]
}
Supported Operators
None
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | exact | ||
| clinical-status | exact | ||
| code | of-type | "system|code|identifier" * | |
| category | "URL|code" ** | ||
| subject | exact | ||
| encounter | exact |
example Condition?code:of-type=|MOH_ICD10|A159 *example category?category=http://clinikal/condition/category/medical_problem|asthma (code is optional)
MedicationStatement
Supported Requests
- [x] read
- [x] search
- [x] create
- [x] update
- [ ] delete
Supported Resource Properties
{
"id": "1",
"resourceType": "MedicationStatement",
"status": "inactive",
"category": {
"coding": [
{
"system": "clinikal/medicationStatement/category/medication",
"code": "Lipitor"
}
],
"text": "Lipitor title"
},
"medicationCodeableConcept": {
"coding": [
{
"system": "http://clinikal/valueset/Daa",
"code": "A10"
}
]
},
"subject": {
"reference": "Patient/1"
},
"context": {
"reference": "Encounter/1"
},
"effectivePeriod": {
"start": "2020-06-01",
"end": "2020-06-07"
},
"dateAsserted": "2020-06-07 07:22:53T13:39:46.000Z",
"informationSource": {
"reference": "Practitioner/1"
},
"note": [
{
"text": "tell here more stuff"
}
]
}
Supported Operators
None
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | exact | ||
| status | exact | ||
| code | of-type | "system|code|identifier" * | |
| patient | exact | ||
| context | exact |
*example MedicationStatement?code:of-type=|codetype|codevalue
Observation
Supported Requests
- [x] read
- [x] search
- [x] create
- [x] update
- [x] patch
- [ ] delete
Supported Resource Properties
{
"id": "11",
"resourceType": "Observation",
"status": "1",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/ValueSet/observation-category",
"code": "vital-signs"
}
],
"text": "Vital Signs"
}
],
"subject": {
"reference": "Patient/2"
},
"encounter": {
"reference": "Encounter/1"
},
"issued": "2020-06-22T07:51:00.000Z",
"performer": [
{
"reference": "Practitioner/1"
}
],
"note": [
{
"text": "דיאטה דחוף "
}
],
"component": [
{
"valueQuantity": {
"value": "120",
"system": "http://loinc.org",
"code": "8480-6"
}
},
{
"valueQuantity": {
"value": "85",
"system": "http://loinc.org",
"code": "8462-4"
}
},
{
"valueQuantity": {
"value": "198.42",
"system": "http://loinc.org",
"code": "8335-2"
}
},
{
"valueQuantity": {
"value": "72.05",
"system": "http://loinc.org",
"code": "8308-9"
}
},
{
"valueQuantity": {
"value": "97.87",
"system": "http://loinc.org",
"code": "8310-5"
}
},
{
"valueQuantity": {
"value": "120",
"system": "http://loinc.org",
"code": "8480-6"
},
"valueCodeableConcept": {
"coding": [
{
"system": "http://loinc.org/8327-9",
"code": "Rectal"
}
]
}
},
{
"valueQuantity": {
"value": "75.00",
"system": "http://loinc.org",
"code": "69000-8"
}
},
{
"valueQuantity": {
"value": "60.00",
"system": "http://loinc.org",
"code": "9303-9"
}
},
{
"valueQuantity": {
"value": "26.9",
"system": "http://loinc.org",
"code": "39156-5"
}
},
{
"valueQuantity": {
"value": "120",
"system": "http://loinc.org",
"code": "8480-6"
},
"valueCodeableConcept": {
"coding": [
{
"system": "http://loinc.org/59574-4",
"code": "Normal BL"
}
]
}
},
{
"valueQuantity": {
"value": "72.00",
"system": "http://loinc.org",
"code": "8280-0"
}
},
{
"valueQuantity": {
"value": "19.69",
"system": "http://loinc.org",
"code": "8287-5"
}
},
{
"valueQuantity": {
"value": "30.00",
"system": "http://loinc.org",
"code": "20564-1"
}
},
{
"valueQuantity": {
"value": "120",
"system": "http://loinc.org",
"code": "74774-1"
}
},
{
"valueQuantity": {
"value": "8",
"system": "http://loinc.org",
"code": "72514-3"
}
},
{
"valueQuantity": {
"value": "85",
"system": "http://loinc.org",
"code": "8462-4"
}
},
{
"valueQuantity": {
"value": "198.42",
"system": "http://loinc.org",
"code": "8335-2"
}
},
{
"valueQuantity": {
"value": "72.05",
"system": "http://loinc.org",
"code": "8308-9"
}
},
{
"valueQuantity": {
"value": "97.87",
"system": "http://loinc.org",
"code": "8310-5"
}
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://loinc.org/8327-9",
"code": "Rectal"
}
]
}
},
{
"valueQuantity": {
"value": "75.00",
"system": "http://loinc.org",
"code": "69000-8"
}
},
{
"valueQuantity": {
"value": "60.00",
"system": "http://loinc.org",
"code": "9303-9"
}
},
{
"valueQuantity": {
"value": "26.9",
"system": "http://loinc.org",
"code": "39156-5"
}
},
{
"valueCodeableConcept": {
"coding": [
{
"system": "http://loinc.org/59574-4",
"code": "Normal BL"
}
]
}
},
{
"valueQuantity": {
"value": "72.00",
"system": "http://loinc.org",
"code": "8280-0"
}
},
{
"valueQuantity": {
"value": "19.69",
"system": "http://loinc.org",
"code": "8287-5"
}
},
{
"valueQuantity": {
"value": "30.00",
"system": "http://loinc.org",
"code": "20564-1"
}
},
{
"valueQuantity": {
"value": "120",
"system": "http://loinc.org",
"code": "74774-1"
}
},
{
"valueQuantity": {
"value": "8",
"system": "http://loinc.org",
"code": "72514-3"
}
}
]
}
Supported Operators
None
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | exact | ||
| issued | exact | ||
| patient | exact | ||
| performer | exact | ||
| status | exact | ||
| encounter | exact | ||
| category | exact |
*example MedicationStatement?code:of-type=|codetype|codevalue
MedicationRequest
Supported Requests
- [x] read
- [x] search
- [x] create
- [x] update
- [x] delete
Supported Resource Properties
{
"id": "1",
"resourceType": "MedicationRequest",
"status": "active",
"medicationCodeableConcept": {
"coding": [
{
"system": "http://clinikal/valueset/drugs",
"code": "123",
"display": "akamol"
}
]
},
"subject": {
"reference": "Patient/1"
},
"encounter": {
"reference": "Encounter/2"
},
"authoredOn": "2020-07-06T06:35:35.000Z",
"requester": {
"reference": "Practitioner/1"
},
"recorder": {
"reference": "Practitioner/1"
},
"note": [
{
"text": "sdfsdfsdf"
}
],
"dosageInstruction": [
{
"timing": {
"repeat": {
"boundsPeriod": {
"start": "2020-07-02",
"end": "2021-03-18"
}
},
"code": {
"coding": [
{
"system": "http://clinikal/valueset/drug_interval",
"code": "1"
}
],
"text": "Once a day"
}
},
"site": {
"coding": [
{
"system": "http://clinikal/valueset/drug_site",
"code": "1"
}
]
},
"route": {
"coding": [
{
"system": "http://clinikal/valueset/drug_route",
"code": "1"
}
],
"text": "Per oris"
},
"method": {
"coding": [
{
"system": "http://clinikal/valueset/drug_form",
"code": "1"
}
],
"text": "Tablet"
},
"doseAndRate": [
{
"doseQuantity": {
"value": "1"
}
}
],
"maxDosePerAdministration": {
"value": "343",
"unit": "9",
"system": "http://clinikal/valueset/units",
"code": "4"
}
}
],
"substitution": {
"allowedBoolean": "true"
}
}
Supported Operators
None
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | exact | ||
| encounter | exact | ||
| patient | exact | ||
| recorder | exact | ||
| requester | exact | ||
| code | exact |
*example MedicationStatement?code:of-type=|codetype|codevalue
ServiceRequest
Supported Requests
- [x] read
- [x] search
- [x] create
- [x] update
- [] delete
Supported Resource Properties
{
"id": "1",
"resourceType": "ServiceRequest",
"status": "active",
"intent": "plan",
"category": [
{
"coding": [
{
"system": "http://clinikal/valueset/service_types",
"code": "1"
}
],
"text": "Emergency Medicine"
}
],
"code": {
"coding": [
{
"system": "http://clinikal/valueset/tests_and_treatments",
"code": "dehydration"
}
],
"text": "EGK"
},
"orderDetail": [
{
"coding": [
{
"system": "http://clinikal/valueset/details_x_ray",
"code": "laboratory_tests"
}
],
"text": "sole"
}
],
"subject": {
"reference": "Patient/1"
},
"encounter": {
"reference": "Encounter/1"
},
"occurrenceDateTime": "2020-07-13T00:00:00.000Z",
"authoredOn": "2020-07-13T00:00:00.000Z",
"requester": {
"reference": "Practitioner/1"
},
"performer": [
{
"reference": "Practitioner/1"
}
],
"reasonCode": [
{
"coding": [
{
"code": "1"
}
]
}
],
"reasonReference": [
{
"reference": "DocumentReference/1"
}
],
"note": [
{
"text": "patient instruction"
}
],
"patientInstruction": "patient instruction"
}
Supported Operators
None
Supported Resource Search Parameters
| Parameter | Prefixes | Modifiers | OR Logic |
|---|---|---|---|
| _id | exact | ||
| encounter | exact | ||
| patient | exact | ||
| authored | exact | * | |
| occurrence | exact | * | |
| status | exact | ||
| _include | ServiceRequest:requester,ServiceRequest:performer | ||
| _sort | _sort=-authored |
- only datetime search
API Examples
Read request:
GET /apis/fhir/v4/Patient/:pid
Search requests:
GET /apis/fhir/v4/Patient
GET /apis/fhir/v4/Patient?_id=1
GET /apis/fhir/v4/Patient?identifier=308826367
GET /apis/fhir/v4/Patient?name=yosi&name=banana
Create request:
POST /apis/fhir/v4/Patient
Update request:
PUT /apis/fhir/v4/Patient/:pid
Patch request:
PATCH /apis/fhir/v4/Patient/:pid
[
{op:"replace", path:"/id", value:"1"},
{op:"replace", path:"/identifier/0/value", value:"3432432"},
{op:"replace", path:"/name/0/family", value:"family"},
{op:"replace", path:"/name/0/given", value:["lname","mname"]},
{op:"replace", path:"/telecom/0", value:{system: "phone",value: "064525252",use: "home" } } ,
{op:"replace", path:"/telecom/1", value:{system: "email",value: "amiel@gmail.com" } } ,
{op:"replace", path:"/telecom/2", value:{system: "phone",value: "0525112396",use: "mobile" } } ,
{op:"replace", path:"/gender", value:"male"},
{op:"replace", path:"/birthDate", value:"1993-05-04" },
{op:"replace", path:"/deceasedBoolean", value:"true" },
{op:"replace", path:"/deceasedDateTime", value: "2020-01-04" },
{op:"replace", path:"/address/0", value:{type:"both",city:"city_3000",postalCode:"4517200",country:"country_254"} },
{op:"replace", path:"/address/0/line", value:["street_200","3","34"] }
]
Delete request:
DELETE apis/fhir/v4/DocumentReference/22
success
{
"resourceType": "OperationOutcome",
"text": {
"status": "generated"
},
"issue": [
{
"severity": "information",
"code": "informational",
"diagnostics": "Successfully deleted 1 resource(s)"
}
]
}
fail
{
"resourceType": "OperationOutcome",
"text": {
"status": "generated"
},
"issue": [
{
"severity": "error",
"code": "processing",
"diagnostics": "Unable to delete DocumentReference/22.failed to delete from doc db"
},
{
"severity": "information",
"code": "information",
"diagnostics": "HTTP Error with status 400 occoured while requesting"
}
]
}