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:

  • An Organization.
  • A Patient.
  • A Practitioner.
  • A Practioner Role (This one is not needed but is a good practice to have reference to Practioner Roles and not to the Practioner because the person that is a practitioner could change or be replaced by another person, but the role does not change).
  • A Group.
  • A CareTeam.

This request will create all the data needed.

Request Body

{"resourceType"=>"Bundle", "id"=>"bundle-transaction", "type"=>"transaction", "entry"=>[{"fullUrl"=>"organization", "resource"=>{"resourceType"=>"Organization", "type"=>[{"coding"=>[{"system"=>"http://hl7.org/fhir/ValueSet/organization-type", "code"=>"prov", "display"=>"Healthcare Provider"}], "text"=>"Healthcare Provider"}], "name"=>"Healthcare Provider Organization"}, "request"=>{"method"=>"POST", "url"=>"Organization"}}, {"fullUrl"=>"patient", "resource"=>{"resourceType"=>"Patient", "active"=>true, "name"=>[{"use"=>"official", "family"=>"Evans", "given"=>["Tiffany", "Elise"]}], "gender"=>"female", "birthDate"=>"1990-12-25"}, "request"=>{"method"=>"POST", "url"=>"Patient"}}, {"fullUrl"=>"group", "resource"=>{"resourceType"=>"Group", "id"=>"id-3", "member"=>[{"entity"=>{"reference"=>"patient"}, "period"=>{"start"=>"2020-10-08"}}], "active"=>true, "type"=>"person", "actual"=>true, "name"=>"South Wing, second floor"}, "request"=>{"method"=>"POST", "url"=>"Group"}}, {"fullUrl"=>"practitioner", "resource"=>{"resourceType"=>"Practitioner", "id"=>"practitioner-1", "active"=>true, "name"=>[{"family"=>"Amud", "given"=>["Angie"], "prefix"=>["Dr."]}], "address"=>[{"line"=>["67 & 100 TER HEUN DRIVE"], "city"=>"FALMOUTH", "state"=>"MA", "postalCode"=>"02540", "country"=>"US"}], "gender"=>"female"}, "request"=>{"method"=>"POST", "url"=>"Practitioner"}}, {"fullUrl"=>"role", "resource"=>{"resourceType"=>"PractitionerRole", "id"=>"practitioner-role-1", "active"=>true, "period"=>{"start"=>"2012-01-01", "end"=>"2012-03-31"}, "practitioner"=>{"reference"=>"practitioner", "display"=>"Dr Angie Amud"}, "organization"=>{"reference"=>"organization"}, "code"=>[{"coding"=>[{"system"=>"http://terminology.hl7.org/CodeSystem/v2-0286", "code"=>"RP"}]}], "specialty"=>[{"coding"=>[{"system"=>"http://snomed.info/sct", "code"=>"408443003", "display"=>"General medical practice"}]}]}, "request"=>{"method"=>"POST", "url"=>"PractitionerRole"}}, {"fullUrl"=>"careteam", "resource"=>{"resourceType"=>"CareTeam", "id"=>"careteam-1", "subject"=>{"reference"=>"group", "display"=>"Second floor patients"}, "period"=>{"start"=>"2020-10-15T01:11:28-05:00", "end"=>"2020-10-16T01:11:28-05:00"}, "participant"=>[{"role"=>[{"coding"=>[{"system"=>"http://snomed.info/sct", "code"=>"116153009", "display"=>"PracticionerRole"}], "text"=>"Practicioner"}], "member"=>{"reference"=>"practitioner", "display"=>"Doctor Angie Amud"}}], "reasonCode"=>[{"coding"=>[{"system"=>"http://snomed.info/sct", "code"=>"10509002", "display"=>"Patient on second floor"}], "text"=>"Patient on second floor"}], "managingOrganization"=>[{"reference"=>"organization", "display"=>"FALMOUTH HOSPITAL"}]}, "request"=>{"method"=>"POST", "url"=>"CareTeam"}}]}

RESPONSES

status: OK

{"resourceType":"Bundle","type":"transaction-response","entry":[{"resource":{"resourceType":"Organization","id":"02274223-d2c2-4a79-a505-565fed4d779f","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"data_uploader"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"288b9904-7f53-47e5-8fb7-18802afa6f61","lastUpdated":"2020-10-20T20:55:48.853931+00:00"},"type":[{"coding":[{"system":"http://hl7.org/fhir/ValueSet/organization-type","code":"prov","display":"Healthcare Provider"}],"text":"Healthcare Provider"}],"name":"Healthcare Provider Organization"},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Organization/02274223-d2c2-4a79-a505-565fed4d779f/_history/288b9904-7f53-47e5-8fb7-18802afa6f61","etag":"W/\"288b9904-7f53-47e5-8fb7-18802afa6f61\"","lastModified":"2020-10-20T20:55:48+00:00"}},{"resource":{"resourceType":"Patient","id":"c7cea518-3ac6-4656-90cd-1e4c71c80955","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"data_uploader"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"7c36af66-3f3a-45b0-8910-9d2602a0f8ec","lastUpdated":"2020-10-20T20:55:48.900224+00:00"},"active":true,"name":[{"use":"official","family":"Evans","given":["Tiffany","Elise"]}],"gender":"female","birthDate":"1990-12-25"},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Patient/c7cea518-3ac6-4656-90cd-1e4c71c80955/_history/7c36af66-3f3a-45b0-8910-9d2602a0f8ec","etag":"W/\"7c36af66-3f3a-45b0-8910-9d2602a0f8ec\"","lastModified":"2020-10-20T20:55:48+00:00"}},{"resource":{"resourceType":"Group","id":"ffc0e3b4-fe25-4e1f-ab27-915a22747173","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"data_uploader"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"8c1dc011-cf44-499a-8123-02592c315d56","lastUpdated":"2020-10-20T20:55:48.950393+00:00"},"active":true,"type":"person","actual":true,"name":"South Wing, second floor","member":[{"entity":{"reference":"Patient/c7cea518-3ac6-4656-90cd-1e4c71c80955"},"period":{"start":"2020-10-08"}}]},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Group/ffc0e3b4-fe25-4e1f-ab27-915a22747173/_history/8c1dc011-cf44-499a-8123-02592c315d56","etag":"W/\"8c1dc011-cf44-499a-8123-02592c315d56\"","lastModified":"2020-10-20T20:55:48+00:00"}},{"resource":{"resourceType":"Practitioner","id":"d2b24495-84ae-4d65-b999-d2da2e6746f7","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"data_uploader"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"2da1988c-858c-4388-9568-3b8fe161282c","lastUpdated":"2020-10-20T20:55:48.994072+00:00"},"active":true,"name":[{"family":"Amud","given":["Angie"],"prefix":["Dr."]}],"address":[{"line":["67 \u0026 100 TER HEUN DRIVE"],"city":"FALMOUTH","state":"MA","postalCode":"02540","country":"US"}],"gender":"female"},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Practitioner/d2b24495-84ae-4d65-b999-d2da2e6746f7/_history/2da1988c-858c-4388-9568-3b8fe161282c","etag":"W/\"2da1988c-858c-4388-9568-3b8fe161282c\"","lastModified":"2020-10-20T20:55:48+00:00"}},{"resource":{"resourceType":"PractitionerRole","id":"82210752-8244-4d4a-afc3-d6c5ffa33127","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"data_uploader"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"1de615a0-cfd7-438c-8954-5d5335e8b7e5","lastUpdated":"2020-10-20T20:55:49.035898+00:00"},"active":true,"period":{"start":"2012-01-01","end":"2012-03-31"},"practitioner":{"reference":"Practitioner/d2b24495-84ae-4d65-b999-d2da2e6746f7","display":"Dr Angie Amud"},"organization":{"reference":"Organization/02274223-d2c2-4a79-a505-565fed4d779f"},"code":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0286","code":"RP"}]}],"specialty":[{"coding":[{"system":"http://snomed.info/sct","code":"408443003","display":"General medical practice"}]}]},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/PractitionerRole/82210752-8244-4d4a-afc3-d6c5ffa33127/_history/1de615a0-cfd7-438c-8954-5d5335e8b7e5","etag":"W/\"1de615a0-cfd7-438c-8954-5d5335e8b7e5\"","lastModified":"2020-10-20T20:55:49+00:00"}},{"resource":{"resourceType":"CareTeam","id":"be76010d-1faf-4f4d-8c65-6da344fcdaa7","meta":{"extension":[{"extension":[{"url":"clientname","valueString":"data_uploader"},{"url":"person","valueReference":{"reference":"Person/bea178a0-6ea4-4b47-99af-e4021bba8f99"}}],"url":"https://commure.com/fhir/provenance/StructureDefinition/creator-structure-map"}],"versionId":"1f8f1d83-3289-4a3e-ab5b-9e7ece99a146","lastUpdated":"2020-10-20T20:55:49.077320+00:00"},"subject":{"reference":"Group/ffc0e3b4-fe25-4e1f-ab27-915a22747173","display":"Second floor patients"},"period":{"start":"2020-10-15T01:11:28-05:00","end":"2020-10-16T01:11:28-05:00"},"participant":[{"role":[{"coding":[{"system":"http://snomed.info/sct","code":"116153009","display":"PracticionerRole"}],"text":"Practicioner"}],"member":{"reference":"PractitionerRole/82210752-8244-4d4a-afc3-d6c5ffa33127","display":"Doctor Angie Amud"}}],"reasonCode":[{"coding":[{"system":"http://snomed.info/sct","code":"10509002","display":"Patient on second floor"}],"text":"Patient on second floor"}],"managingOrganization":[{"reference":"Organization/02274223-d2c2-4a79-a505-565fed4d779f","display":"FALMOUTH HOSPITAL"}]},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/CareTeam/be76010d-1faf-4f4d-8c65-6da344fcdaa7/_history/1f8f1d83-3289-4a3e-ab5b-9e7ece99a146","etag":"W/\"1f8f1d83-3289-4a3e-ab5b-9e7ece99a146\"","lastModified":"2020-10-20T20:55:49+00:00"}}]}