1. Setup scenario

POST https://api-{{tenant-id}}.developer.commure.com/api/v1/r4/

For this scenario we will assume that the following data is already saved in the FHIR database: * Patient. * Practitioner. * A Schedule of the Practitioner. * A Slot related to the Schedule (A slot of time on a schedule that may be available for booking appointments). * A Medication Statement of the Patient. * The patient’s history.

This request will create all the data needed.

Request Body

{"resourceType"=>"Bundle", "id"=>"bundle-transaction", "type"=>"transaction", "entry"=>[{"fullUrl"=>"patient", "resource"=>{"resourceType"=>"Patient", "active"=>true, "name"=>[{"use"=>"official", "family"=>"Lopez", "given"=>["Zaniar", "Fernando"]}], "gender"=>"male", "birthDate"=>"1995-12-25"}, "request"=>{"method"=>"POST", "url"=>"Patient"}}, {"fullUrl"=>"practitioner", "resource"=>{"resourceType"=>"Practitioner", "id"=>"practitioner-1", "active"=>true, "name"=>[{"family"=>"Mendoza", "given"=>["Daniel"], "prefix"=>["Dr."]}], "address"=>[{"line"=>["67 & 100 TER HEUN DRIVE"], "city"=>"FALMOUTH", "state"=>"MA", "postalCode"=>"02540", "country"=>"US"}], "gender"=>"male"}, "request"=>{"method"=>"POST", "url"=>"Practitioner"}}, {"fullUrl"=>"family-member-history", "resource"=>{"resourceType"=>"FamilyMemberHistory", "status"=>"completed", "patient"=>{"reference"=>"patient"}, "relationship"=>{"coding"=>[{"system"=>"http://hl7.org/fhir/v3/RoleCode", "code"=>"FTH", "display"=>"father"}], "text"=>"Father"}, "condition"=>[{"code"=>{"coding"=>[{"system"=>"http://snomed.info/sct", "code"=>"38341003", "display"=>"Hypertension"}], "text"=>"Hypertension"}}, {"code"=>{"coding"=>[{"system"=>"http://snomed.info/sct", "code"=>"53741008", "display"=>"Coronary Heart Disease"}], "text"=>"Coronary Heart Disease"}}]}, "request"=>{"method"=>"POST", "url"=>"FamilyMemberHistory"}}, {"fullUrl"=>"observation", "resource"=>{"resourceType"=>"Observation", "status"=>"final", "category"=>[{"coding"=>[{"system"=>"http://terminology.hl7.org/CodeSystem/observation-category", "code"=>"vital-signs", "display"=>"Vital Signs"}], "text"=>"Vital Signs"}], "code"=>{"coding"=>[{"system"=>"http://loinc.org", "code"=>"8302-2", "display"=>"Body height"}], "text"=>"Body height"}, "subject"=>{"reference"=>"patient"}, "effectiveDateTime"=>"2020-01-01", "valueQuantity"=>{"value"=>66.89999999999999, "unit"=>"in", "system"=>"http://unitsofmeasure.org", "code"=>"[in_i]"}}, "request"=>{"method"=>"POST", "url"=>"Observation"}}, {"fullUrl"=>"condition", "resource"=>{"resourceType"=>"Condition", "clinicalStatus"=>{"coding"=>[{"system"=>"http://terminology.hl7.org/CodeSystem/condition-clinical", "code"=>"active"}]}, "verificationStatus"=>{"coding"=>[{"system"=>"http://terminology.hl7.org/CodeSystem/condition-ver-status", "code"=>"confirmed"}]}, "code"=>{"coding"=>[{"system"=>"http://snomed.info/sct", "code"=>"368581000119106", "display"=>"Neuropathy due to type 2 diabetes mellitus (disorder)"}], "text"=>"Neuropathy due to type 2 diabetes mellitus (disorder)"}, "subject"=>{"reference"=>"patient"}, "onsetDateTime"=>"2020-12-24T02:27:02-05:00", "recordedDate"=>"2020-12-24"}, "request"=>{"method"=>"POST", "url"=>"Condition"}}, {"fullUrl"=>"schedule", "resource"=>{"resourceType"=>"Schedule", "active"=>true, "actor"=>[{"reference"=>"practitioner"}]}, "request"=>{"method"=>"POST", "url"=>"Schedule"}}, {"fullUrl"=>"slot", "resource"=>{"resourceType"=>"Slot", "schedule"=>{"reference"=>"schedule"}, "status"=>"free", "start"=>"2020-01-01T13:00:00.000+00:00", "end"=>"2020-01-01T15:00:00.000+00:00", "overbooked"=>false}, "request"=>{"method"=>"POST", "url"=>"Slot"}}, {"fullUrl"=>"medication-statement", "resource"=>{"resourceType"=>"MedicationStatement", "status"=>"completed", "category"=>{"coding"=>[{"system"=>"http://hl7.org/fhir/medication-statement-category", "code"=>"inpatient", "display"=>"Inpatient", "userSelected"=>true}], "text"=>"Inpatient"}, "medicationCodeableConcept"=>{"coding"=>[{"system"=>"http://snomed.info/sct", "code"=>"50580-506-02", "display"=>"Tylenol PM"}]}, "subject"=>{"reference"=>"patient"}, "effectiveDateTime"=>"2014-01-23", "dateAsserted"=>"2015-02-22", "informationSource"=>{"reference"=>"urn:uuid:"}, "reasonCode"=>[{"coding"=>[{"system"=>"http://snomed.info/sct", "code"=>"32914008", "display"=>"Restless LegsM"}]}], "dosage"=>[{"text"=>"one capsule three times daily", "timing"=>{"repeat"=>{"frequency"=>3, "period"=>1, "periodUnit"=>"d"}}, "asNeededBoolean"=>false, "route"=>{"coding"=>[{"system"=>"http://snomed.info/sct", "code"=>"260548002", "display"=>"Oral"}]}, "maxDosePerPeriod"=>{"numerator"=>{"value"=>3, "unit"=>"capsules", "system"=>"http://snomed.info/sct", "code"=>"385055001"}, "denominator"=>{"value"=>1, "system"=>"http://unitsofmeasure.org", "code"=>"d"}}}]}, "request"=>{"method"=>"POST", "url"=>"MedicationStatement"}}, {"fullUrl"=>"careplan", "resource"=>{"resourceType"=>"CarePlan", "status"=>"completed", "intent"=>"plan", "subject"=>{"reference"=>"Patient/{{patient-id}}", "display"=>"P. van de Heuvel"}, "period"=>{"start"=>"2019-06-26", "end"=>"2020-06-27"}, "activity"=>[{"detail"=>{"kind"=>"ServiceRequest", "code"=>{"coding"=>[{"system"=>"http://snomed.info/sct", "code"=>"64915003", "display"=>"Operation on heart"}]}, "status"=>"completed", "doNotPerform"=>true, "scheduledString"=>"2011-06-27T09:30:10+01:00", "performer"=>[{"reference"=>"Practitioner/{{practitioner-id}}", "display"=>"P. Voigt"}]}}]}, "request"=>{"method"=>"POST", "url"=>"CarePlan"}}, {"fullUrl"=>"procedure", "resource"=>{"resourceType"=>"Procedure", "status"=>"completed", "code"=>{"coding"=>[{"system"=>"http://snomed.info/sct", "code"=>"274474001", "display"=>"Bone immobilization"}], "text"=>"Bone immobilization"}, "subject"=>{"reference"=>"patient"}, "performedPeriod"=>{"start"=>"2015-04-08T02:11:28-04:00", "end"=>"2015-04-08T02:33:28-04:00"}}, "request"=>{"method"=>"POST", "url"=>"Procedure"}}, {"fullUrl"=>"endpoint-id", "resource"=>{"resourceType"=>"Endpoint", "status"=>"active", "name"=>"TELEHEALTH VIDEO CALL SYSTEM", "address"=>"mailto:MARTIN.SMIETANKA@directnppes.com", "connectionType"=>{"code"=>"direct-project"}, "payloadType"=>[{"coding"=>[{"system"=>"urn:oid:1.3.6.1.4.1.19376.1.2.3", "code"=>"urn:ihe:pcc:cm:2008"}]}]}, "request"=>{"method"=>"POST", "url"=>"Endpoint"}}]}

RESPONSES

status: OK

{"resourceType":"Bundle","type":"transaction-response","entry":[{"resource":{"resourceType":"Patient","id":"1c207762-db80-49db-aff5-4a9b81837d68","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"dashboard"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"f47a4379-430d-487f-9f50-a4fb05061659","lastUpdated":"2020-11-02T12:21:25.087300+00:00"},"active":true,"name":[{"use":"official","family":"Lopez","given":["Zaniar","Fernando"]}],"gender":"male","birthDate":"1995-12-25"},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Patient/1c207762-db80-49db-aff5-4a9b81837d68/_history/f47a4379-430d-487f-9f50-a4fb05061659","etag":"W/\"f47a4379-430d-487f-9f50-a4fb05061659\"","lastModified":"2020-11-02T12:21:25+00:00"}},{"resource":{"resourceType":"Practitioner","id":"cbe538c4-6784-4903-bad5-bfc3f6a56ce9","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"dashboard"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"42ae7ca2-8a21-4db8-9b49-5efb83f1ac6a","lastUpdated":"2020-11-02T12:21:25.126035+00:00"},"active":true,"name":[{"family":"Mendoza","given":["Daniel"],"prefix":["Dr."]}],"address":[{"line":["67 \u0026 100 TER HEUN DRIVE"],"city":"FALMOUTH","state":"MA","postalCode":"02540","country":"US"}],"gender":"male"},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Practitioner/cbe538c4-6784-4903-bad5-bfc3f6a56ce9/_history/42ae7ca2-8a21-4db8-9b49-5efb83f1ac6a","etag":"W/\"42ae7ca2-8a21-4db8-9b49-5efb83f1ac6a\"","lastModified":"2020-11-02T12:21:25+00:00"}},{"resource":{"resourceType":"FamilyMemberHistory","id":"ffb244b5-1d62-4baf-8bad-1fd48f7f9368","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"dashboard"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"a9781a6a-a25b-40a4-9f5d-27c550b5904a","lastUpdated":"2020-11-02T12:21:25.162354+00:00"},"status":"completed","patient":{"reference":"Patient/1c207762-db80-49db-aff5-4a9b81837d68"},"relationship":{"coding":[{"system":"http://hl7.org/fhir/v3/RoleCode","code":"FTH","display":"father"}],"text":"Father"},"condition":[{"code":{"coding":[{"system":"http://snomed.info/sct","code":"38341003","display":"Hypertension"}],"text":"Hypertension"}},{"code":{"coding":[{"system":"http://snomed.info/sct","code":"53741008","display":"Coronary Heart Disease"}],"text":"Coronary Heart Disease"}}]},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/FamilyMemberHistory/ffb244b5-1d62-4baf-8bad-1fd48f7f9368/_history/a9781a6a-a25b-40a4-9f5d-27c550b5904a","etag":"W/\"a9781a6a-a25b-40a4-9f5d-27c550b5904a\"","lastModified":"2020-11-02T12:21:25+00:00"}},{"resource":{"resourceType":"Observation","id":"e18ad066-136d-4ed4-b515-e1d5a1411e11","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"dashboard"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"64d790a4-84c7-4b1d-a4aa-8c5e9f04f2bb","lastUpdated":"2020-11-02T12:21:25.197532+00:00"},"status":"final","category":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/observation-category","code":"vital-signs","display":"Vital Signs"}],"text":"Vital Signs"}],"code":{"coding":[{"system":"http://loinc.org","code":"8302-2","display":"Body height"}],"text":"Body height"},"subject":{"reference":"Patient/1c207762-db80-49db-aff5-4a9b81837d68"},"effectiveDateTime":"2020-01-01","valueQuantity":{"value":66.89999999999999,"unit":"in","system":"http://unitsofmeasure.org","code":"[in_i]"}},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Observation/e18ad066-136d-4ed4-b515-e1d5a1411e11/_history/64d790a4-84c7-4b1d-a4aa-8c5e9f04f2bb","etag":"W/\"64d790a4-84c7-4b1d-a4aa-8c5e9f04f2bb\"","lastModified":"2020-11-02T12:21:25+00:00"}},{"resource":{"resourceType":"Condition","id":"2005af0d-6138-4ab4-a235-5313184009cb","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"dashboard"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"c9bd4487-7fe1-4a45-963f-977100e195c3","lastUpdated":"2020-11-02T12:21:25.239013+00:00"},"clinicalStatus":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/condition-clinical","code":"active"}]},"verificationStatus":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/condition-ver-status","code":"confirmed"}]},"code":{"coding":[{"system":"http://snomed.info/sct","code":"368581000119106","display":"Neuropathy due to type 2 diabetes mellitus (disorder)"}],"text":"Neuropathy due to type 2 diabetes mellitus (disorder)"},"subject":{"reference":"Patient/1c207762-db80-49db-aff5-4a9b81837d68"},"onsetDateTime":"2020-12-24T02:27:02-05:00","recordedDate":"2020-12-24"},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Condition/2005af0d-6138-4ab4-a235-5313184009cb/_history/c9bd4487-7fe1-4a45-963f-977100e195c3","etag":"W/\"c9bd4487-7fe1-4a45-963f-977100e195c3\"","lastModified":"2020-11-02T12:21:25+00:00"}},{"resource":{"resourceType":"Schedule","id":"57cfde1c-e043-471e-94b6-3a0f9498bdfd","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"dashboard"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"9095aa82-c9d1-4168-a7c2-73d071f64fe0","lastUpdated":"2020-11-02T12:21:25.278322+00:00"},"active":true,"actor":[{"reference":"Practitioner/cbe538c4-6784-4903-bad5-bfc3f6a56ce9"}]},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Schedule/57cfde1c-e043-471e-94b6-3a0f9498bdfd/_history/9095aa82-c9d1-4168-a7c2-73d071f64fe0","etag":"W/\"9095aa82-c9d1-4168-a7c2-73d071f64fe0\"","lastModified":"2020-11-02T12:21:25+00:00"}},{"resource":{"resourceType":"Slot","id":"55d83682-cf8a-48f7-9341-fae956fcf3a8","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"dashboard"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"5c16c9fd-5d41-4915-80b3-18a9032668b5","lastUpdated":"2020-11-02T12:21:25.313184+00:00"},"schedule":{"reference":"Schedule/57cfde1c-e043-471e-94b6-3a0f9498bdfd"},"status":"free","start":"2020-01-01T13:00:00+00:00","end":"2020-01-01T15:00:00+00:00","overbooked":false,"comment":"Comments on the slot"},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Slot/55d83682-cf8a-48f7-9341-fae956fcf3a8/_history/5c16c9fd-5d41-4915-80b3-18a9032668b5","etag":"W/\"5c16c9fd-5d41-4915-80b3-18a9032668b5\"","lastModified":"2020-11-02T12:21:25+00:00"}},{"resource":{"resourceType":"MedicationStatement","id":"6b4976a2-a404-4c9a-8db8-163dd549a433","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"dashboard"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"f58f2518-f813-4375-bb41-d07d22fe10ed","lastUpdated":"2020-11-02T12:21:25.343527+00:00"},"status":"completed","category":{"coding":[{"system":"http://hl7.org/fhir/medication-statement-category","code":"inpatient","display":"Inpatient","userSelected":true}],"text":"Inpatient"},"medicationCodeableConcept":{"coding":[{"system":"http://snomed.info/sct","code":"50580-506-02","display":"Tylenol PM"}]},"subject":{"reference":"Patient/1c207762-db80-49db-aff5-4a9b81837d68"},"effectiveDateTime":"2014-01-23","dateAsserted":"2015-02-22","informationSource":{"reference":"urn:uuid:"},"reasonCode":[{"coding":[{"system":"http://snomed.info/sct","code":"32914008","display":"Restless LegsM"}]}],"dosage":[{"text":"one capsule three times daily","timing":{"repeat":{"frequency":3,"period":1,"periodUnit":"d"}},"asNeededBoolean":false,"route":{"coding":[{"system":"http://snomed.info/sct","code":"260548002","display":"Oral"}]},"maxDosePerPeriod":{"numerator":{"value":3,"unit":"capsules","system":"http://snomed.info/sct","code":"385055001"},"denominator":{"value":1,"system":"http://unitsofmeasure.org","code":"d"}}}]},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/MedicationStatement/6b4976a2-a404-4c9a-8db8-163dd549a433/_history/f58f2518-f813-4375-bb41-d07d22fe10ed","etag":"W/\"f58f2518-f813-4375-bb41-d07d22fe10ed\"","lastModified":"2020-11-02T12:21:25+00:00"}},{"resource":{"resourceType":"CarePlan","id":"c51d088f-12d6-4797-9613-1d764de7b425","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"dashboard"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"b9c6b6dd-7692-47e9-a4e5-a68a4f83496d","lastUpdated":"2020-11-02T12:21:25.381416+00:00"},"status":"completed","intent":"plan","subject":{"reference":"Patient/418e74e0-9a8e-40a1-973b-a854b2f8ca6f","display":"P. van de Heuvel"},"period":{"start":"2019-06-26","end":"2020-06-27"},"activity":[{"detail":{"kind":"ServiceRequest","code":{"coding":[{"system":"http://snomed.info/sct","code":"64915003","display":"Operation on heart"}]},"status":"completed","doNotPerform":true,"scheduledString":"2011-06-27T09:30:10+01:00","performer":[{"reference":"Practitioner/df5265e7-3545-45db-9be9-2ac41584c71a","display":"P. Voigt"}]}}]},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/CarePlan/c51d088f-12d6-4797-9613-1d764de7b425/_history/b9c6b6dd-7692-47e9-a4e5-a68a4f83496d","etag":"W/\"b9c6b6dd-7692-47e9-a4e5-a68a4f83496d\"","lastModified":"2020-11-02T12:21:25+00:00"}},{"resource":{"resourceType":"Procedure","id":"3838bcf1-8552-4648-ae7f-ac1bc8273c9e","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"dashboard"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"1aec92ce-6ebd-4b5c-b406-379a7dba6223","lastUpdated":"2020-11-02T12:21:25.435476+00:00"},"status":"completed","code":{"coding":[{"system":"http://snomed.info/sct","code":"274474001","display":"Bone immobilization"}],"text":"Bone immobilization"},"subject":{"reference":"Patient/1c207762-db80-49db-aff5-4a9b81837d68"},"performedPeriod":{"start":"2015-04-08T02:11:28-04:00","end":"2015-04-08T02:33:28-04:00"}},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Procedure/3838bcf1-8552-4648-ae7f-ac1bc8273c9e/_history/1aec92ce-6ebd-4b5c-b406-379a7dba6223","etag":"W/\"1aec92ce-6ebd-4b5c-b406-379a7dba6223\"","lastModified":"2020-11-02T12:21:25+00:00"}},{"resource":{"resourceType":"Endpoint","id":"2501918e-d224-4b75-8654-bb8361b2f165","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"dashboard"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"5e4c66cb-15a6-4c6b-98f3-24149fa689be","lastUpdated":"2020-11-02T12:21:25.465278+00:00"},"status":"active","connectionType":{"code":"direct-project"},"name":"TELEHEALTH VIDEO CALL SYSTEM","payloadType":[{"coding":[{"system":"urn:oid:1.3.6.1.4.1.19376.1.2.3","code":"urn:ihe:pcc:cm:2008"}]}],"address":"mailto:MARTIN.SMIETANKA@directnppes.com"},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Endpoint/2501918e-d224-4b75-8654-bb8361b2f165/_history/5e4c66cb-15a6-4c6b-98f3-24149fa689be","etag":"W/\"5e4c66cb-15a6-4c6b-98f3-24149fa689be\"","lastModified":"2020-11-02T12:21:25+00:00"}}]}