1. Prerequisite data: a Questionnaire, Patient, and Organization

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

The first request will create the resources needed to navigate this scenario: A Questionnaire, the Patient that will be the subject of our response to the Questionnaire, and an Organization that will be referenced as the patient’s insurance company.

Although any resource can be identified and retrieved by id, for resources like Questionnaire that have a URL field, it is preferable to identify the resource with the value of that field, known as the canonical URL. This is typical of resources that may be available and identifiable across many different environments.

Note that the Bundle in this request makes use of the conditional update operation, which we recommend avoiding in production applications.

Request Body

{"resourceType"=>"Bundle", "type"=>"transaction", "entry"=>[{"request"=>{"method"=>"PUT", "url"=>"Questionnaire?url=https://commure.com/fhir/Questionnaire/insurance"}, "resource"=>{"resourceType"=>"Questionnaire", "name"=>"patient-insurance", "status"=>"active", "title"=>"Patient Insurance", "url"=>"https://commure.com/fhir/Questionnaire/insurance", "version"=>"1.0.0", "extension"=>[{"url"=>"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext", "extension"=>[{"url"=>"name", "valueId"=>"patient"}, {"url"=>"type", "valueCode"=>"patient"}]}, {"url"=>"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext", "extension"=>[{"url"=>"name", "valueId"=>"coverage"}, {"url"=>"type", "valueCode"=>"coverage"}]}], "item"=>[{"linkId"=>"coverage", "type"=>"group", "extension"=>[{"url"=>"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemContext", "valueExpression"=>{"expression"=>"Coverage", "language"=>"application/x-fhir-query"}}], "item"=>[{"definition"=>"http://hl7.org/fhir/StructureDefinition/Coverage#Coverage.subscriberId", "linkId"=>"subscriber-id", "type"=>"string", "text"=>"Insurance Id Number", "extension"=>[{"url"=>"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression", "valueExpression"=>{"expression"=>"%coverage.subscriberId", "language"=>"text/fhirpath"}}]}, {"definition"=>"http://hl7.org/fhir/StructureDefinition/Coverage#Coverage.payor", "linkId"=>"payor", "type"=>"reference", "text"=>"Insurance company name", "extension"=>[{"url"=>"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression", "valueExpression"=>{"expression"=>"%coverage.payor", "language"=>"text/fhirpath"}}]}, {"answerValueSet"=>"http://hl7.org/fhir/ValueSet/fm-status", "definition"=>"http://hl7.org/fhir/StructureDefinition/Coverage#Coverage.status", "linkId"=>"status", "type"=>"choice", "text"=>"Status of coverage", "extension"=>[{"url"=>"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression", "valueExpression"=>{"expression"=>"%coverage.status", "language"=>"text/fhirpath"}}], "initial"=>[{"valueCoding"=>{"code"=>"active", "system"=>"http://hl7.org/fhir/ValueSet/fm-status"}}]}, {"definition"=>"http://hl7.org/fhir/StructureDefinition/Coverage#Coverage.beneficiary.reference", "linkId"=>"beneficiary-reference", "type"=>"string", "extension"=>[{"url"=>"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression", "valueExpression"=>{"expression"=>"'Patient/'+%patient.id", "language"=>"text/fhirpath"}}, {"url"=>"http://hl7.org/fhir/StructureDefinition/questionnaire-hidden", "valueBoolean"=>true}], "required"=>true}, {"definition"=>"http://hl7.org/fhir/StructureDefinition/Coverage#Coverage.id", "linkId"=>"coverage-id", "type"=>"string", "extension"=>[{"url"=>"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression", "valueExpression"=>{"expression"=>"%coverage.id", "language"=>"text/fhirpath"}}, {"url"=>"http://hl7.org/fhir/StructureDefinition/questionnaire-hidden", "valueBoolean"=>true}]}]}], "meta"=>{"profile"=>["http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire", "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-populate", "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extract"]}, "subjectType"=>["Patient"]}}, {"fullUrl"=>"transaction-reference-patient", "request"=>{"method"=>"PUT", "url"=>"Patient?identifier=https://commure.com/fhir/sample-identifier-system|sample-patient-giuseppe"}, "resource"=>{"resourceType"=>"Patient", "identifier"=>[{"system"=>"https://commure.com/fhir/sample-identifier-system", "value"=>"sample-patient-giuseppe"}], "name"=>[{"family"=>"Valentini", "given"=>["Giuseppe"]}]}}, {"request"=>{"method"=>"PUT", "url"=>"Organization?identifier=https://commure.com/fhir/sample-identifier-system|sample-insurance-company"}, "resource"=>{"name"=>"Insurance Corp of Healthyland", "resourceType"=>"Organization", "identifier"=>[{"system"=>"https://commure.com/fhir/sample-identifier-system", "value"=>"sample-insurance-company"}], "type"=>[{"coding"=>[{"code"=>"ins", "display"=>"Insurance Company", "system"=>"http://terminology.hl7.org/CodeSystem/organization-type"}]}], "active"=>true}}]}

RESPONSES

status: OK

{"resourceType":"Bundle","type":"transaction-response","entry":[{"resource":{"resourceType":"Questionnaire","id":"2b3cd557-d8e0-4ebe-8322-fabacb95f9bc","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":"53118811-55e0-4337-81dc-06ebc85b2a2d","lastUpdated":"2020-10-21T16:16:33.649723+00:00","profile":["http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire","http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-populate","http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-extract"]},"extension":[{"extension":[{"url":"name","valueId":"patient"},{"url":"type","valueCode":"patient"},{"url":"description","valueString":"Patient that is the subject of this questionnaire"}],"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext"},{"extension":[{"url":"name","valueId":"account"},{"url":"type","valueCode":"account"},{"url":"description","valueString":"Account of the subject Patient"}],"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext"}],"url":"http://commure.com/fhir/Questionnaire/guarantor","version":"1.0.0","name":"patient-guarantor","title":"Patient Guarantor","status":"active","subjectType":["Patient"],"item":[{"extension":[{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemContext","valueExpression":{"language":"application/x-fhir-query","expression":"Account"}}],"linkId":"guarantor-page","text":"Guarantor","type":"group","item":[{"extension":[{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemContext","valueExpression":{"name":"guarantor","language":"text/fhirpath","expression":"%account.guarantor[0]"}}],"linkId":"guarantor-group","definition":"http://hl7.org/fhir/StructureDefinition/Account#Account.guarantor","type":"group","item":[{"extension":[{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression","valueExpression":{"language":"text/fhirpath","expression":"%guarantor.party.reference.exists() = false or %guarantor.party.reference = 'Patient/' + %patient.id"}}],"linkId":"guarantor-wants-to-be-patient","text":"Same as patient","type":"boolean"},{"extension":[{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression","valueExpression":{"language":"text/fhirpath","expression":"%guarantor.party.exists(reference=('Patient/' + %patient.id))"}},{"url":"http://hl7.org/fhir/StructureDefinition/questionnaire-hidden","valueBoolean":true}],"linkId":"self-guarantor-exists","type":"boolean"},{"extension":[{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression","valueExpression":{"language":"text/fhirpath","expression":"%account.guarantor.party"}}],"linkId":"guarantor","definition":"http://hl7.org/fhir/StructureDefinition/Account#Account.guarantor.party","text":"Guarantor","type":"reference","enableWhen":[{"question":"guarantor-wants-to-be-patient","operator":"=","answerBoolean":false}],"required":true},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/questionnaire-hidden","valueBoolean":true},{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression","valueExpression":{"language":"text/fhirpath","expression":"%account.guarantor.party.reference"}}],"linkId":"guarantor-existing-self-reference","definition":"http://hl7.org/fhir/StructureDefinition/Account#Account.guarantor.party.reference","type":"string","enableWhen":[{"question":"guarantor-wants-to-be-patient","operator":"=","answerBoolean":true},{"question":"self-guarantor-exists","operator":"exists","answerBoolean":true}],"enableBehavior":"all"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/questionnaire-hidden","valueBoolean":true},{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression","valueExpression":{"language":"text/fhirpath","expression":"%account.guarantor.party.type"}}],"linkId":"guarantor-existing-self-reference-type","definition":"http://hl7.org/fhir/StructureDefinition/Account#Account.guarantor.party.type","type":"string","enableWhen":[{"question":"guarantor-wants-to-be-patient","operator":"=","answerBoolean":true},{"question":"self-guarantor-exists","operator":"exists","answerBoolean":true}],"enableBehavior":"all"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/questionnaire-hidden","valueBoolean":true},{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression","valueExpression":{"language":"text/fhirpath","expression":"'Patient/' + %patient.id"}}],"linkId":"guarantor-new-self-reference","definition":"http://hl7.org/fhir/StructureDefinition/Account#Account.guarantor.party.reference","type":"string","enableWhen":[{"question":"guarantor-wants-to-be-patient","operator":"=","answerBoolean":true},{"question":"self-guarantor-exists","operator":"=","answerBoolean":false}],"enableBehavior":"all"},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/questionnaire-hidden","valueBoolean":true}],"linkId":"guarantor-new-self-reference-type","definition":"http://hl7.org/fhir/StructureDefinition/Account#Account.guarantor.party.type","type":"string","enableWhen":[{"question":"guarantor-wants-to-be-patient","operator":"=","answerBoolean":true},{"question":"self-guarantor-exists","operator":"=","answerBoolean":false}],"enableBehavior":"all","initial":[{"valueString":"Patient"}]}]},{"linkId":"guarantor-related-person","type":"group","item":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/questionnaire-hidden","valueBoolean":true}],"linkId":"account","type":"group","item":[{"extension":[{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression","valueExpression":{"language":"text/fhirpath","expression":"%account.id"}}],"linkId":"account-id","definition":"http://hl7.org/fhir/StructureDefinition/Account#Account.id","type":"string"},{"extension":[{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemContext","valueExpression":{"name":"subject","language":"text/fhirpath","expression":"%account.subject"}}],"linkId":"account-subject-existing-group","definition":"http://hl7.org/fhir/StructureDefinition/Account#Account.subject","type":"group","item":[{"extension":[{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression","valueExpression":{"language":"text/fhirpath","expression":"%subject.reference"}}],"linkId":"account-subject-existing","definition":"http://hl7.org/fhir/StructureDefinition/Account#Account.subject.reference","type":"string"}]},{"extension":[{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression","valueExpression":{"language":"text/fhirpath","expression":"'Patient/' + %patient.id"}}],"linkId":"account-subject-new","definition":"http://hl7.org/fhir/StructureDefinition/Account#Account.subject.reference","type":"string","enableWhen":[{"question":"account-subject-existing","operator":"exists","answerBoolean":false}]},{"extension":[{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression","valueExpression":{"language":"text/fhirpath","expression":"%account.status"}}],"linkId":"account-status","definition":"http://hl7.org/fhir/StructureDefinition/Account#Account.status","type":"choice","answerValueSet":"http://hl7.org/fhir/ValueSet/account-status","initial":[{"valueCoding":{"system":"http://hl7.org/fhir/account-status","code":"active"}}]},{"extension":[{"url":"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression","valueExpression":{"language":"text/fhirpath","expression":"%account.owner"}}],"linkId":"account-owner","definition":"http://hl7.org/fhir/StructureDefinition/Account#Account.owner","type":"reference","initial":[{"valueReference":{"type":"Organization","identifier":{"system":"https://commure.com/fhir/identifiers/Organization/commure","value":"commure"}}}]}]}]}]}]},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Questionnaire/2b3cd557-d8e0-4ebe-8322-fabacb95f9bc/_history/53118811-55e0-4337-81dc-06ebc85b2a2d","etag":"W/\"53118811-55e0-4337-81dc-06ebc85b2a2d\"","lastModified":"2020-10-21T16:16:33+00:00"}},{"resource":{"resourceType":"Patient","id":"cca00185-bc2e-435f-af0b-eecb8d4af9c2","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":"bd250ec1-2d24-49ec-9c52-5c7573d7b520","lastUpdated":"2020-10-21T16:16:33.711007+00:00"},"name":[{"family":"Patient","given":["Test"]}]},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Patient/cca00185-bc2e-435f-af0b-eecb8d4af9c2/_history/bd250ec1-2d24-49ec-9c52-5c7573d7b520","etag":"W/\"bd250ec1-2d24-49ec-9c52-5c7573d7b520\"","lastModified":"2020-10-21T16:16:33+00:00"}},{"resource":{"resourceType":"Person","id":"af46fbed-38e8-48c3-bfba-dd883a19bac2","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":"405f0a43-17cb-49be-a0c9-1316b2f279b1","lastUpdated":"2020-10-21T16:16:33.755109+00:00"},"name":[{"family":"Patient","given":["Test"]}],"active":true,"link":[{"target":{"reference":"Patient/cca00185-bc2e-435f-af0b-eecb8d4af9c2"}}]},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Person/af46fbed-38e8-48c3-bfba-dd883a19bac2/_history/405f0a43-17cb-49be-a0c9-1316b2f279b1","etag":"W/\"405f0a43-17cb-49be-a0c9-1316b2f279b1\"","lastModified":"2020-10-21T16:16:33+00:00"}},{"resource":{"resourceType":"Encounter","id":"c85827b1-13e5-401c-89c5-774c77102346","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":"2ac36db1-f3fb-49da-8ee4-ca3d8518ca9d","lastUpdated":"2020-10-21T16:16:33.805923+00:00"},"status":"in-progress","class":{"system":"http://terminology.hl7.org/CodeSystem/v3-ActCode","code":"PRENC","display":"pre-admission"},"subject":{"reference":"Patient/cca00185-bc2e-435f-af0b-eecb8d4af9c2","type":"Patient"},"period":{"start":"2020-10-20T01:45:32.00-05:00"}},"response":{"status":"201","location":"https://api-53914125.developer.commure.com/api/v1/r4/Encounter/c85827b1-13e5-401c-89c5-774c77102346/_history/2ac36db1-f3fb-49da-8ee4-ca3d8518ca9d","etag":"W/\"2ac36db1-f3fb-49da-8ee4-ca3d8518ca9d\"","lastModified":"2020-10-21T16:16:33+00:00"}}]}