The HealtheIntent Longitudinal Record is a comprehensive clinical summary for a patient in context of a population. The Longitudinal Record is comprised of aggregated patient data from multiple data sources.
Note: The data retrieved by this API is filtered based on the sensitive data filters for HealtheIntent. Ensure that your implementations of this API are designed with this in mind, and if you integrate data from HealtheIntent into a clinical workflow using this API, ensure that your users are informed of your sensitive data filters. See Understand Sensitive Data in HealtheIntent in the Reference Pages on Cerner Wiki for more information.
DocumentReference is used to index a document, diagnostic report, clinical note, or other binary object. The document establishes context through metadata (such as the author, description, or status) and references the binary contents of the document. The document contents can be any binary object with a recognized Multipurpose Internet Mail Extensions (MIME) type. For example, document contents can include structured documents in eXtensible Markup Language (XML), clinical notes in plain text, or a scanned report in Portable Document Format (PDF).
Retrieve a Single Document Reference
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/document-references/f09385c8e68530e2227097cffb70e464437b6faf560ee3a8ffca84369291e2b8',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/document-references/f09385c8e68530e2227097cffb70e464437b6faf560ee3a8ffca84369291e2b8 \
-H 'Authorization: {auth_header}'\
-H 'Accept: application/json'
Example response
{"id":"581433f4-b179-3df4-9bb2-9768ef76493c","authenticator":{"type":"PROVIDER","provider":{"aliases":[{"system":"2.16.840.1.113883.4.814","value":"2112186","type":"DEA"}],"name":{"prefix":"Dr.","given":["Jane","Susannah"],"family":["Smith"],"suffix":"MD","formatted":"Dr. Jane Susannah Smith MD"}}},"categories":[{"sourceCodings":[],"codings":[{"system":"http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category","code":"clinical-note","display":"Clinical Note"}],"concepts":[{"contextId":"a092e06f-7690-4ace-a678-885913a35d46","alias":"CLINICAL_NOTE_OBSTYPE"}],"text":"Clinical Note"}],"dateTime":"2011-07-26T23:53:00.000Z","description":"Physician Emergency Department Note","docStatus":{"sourceCodings":[{"code":"25","display":"Auth (Verified)","system":"urn:cerner:coding:codingsystem:codeset:8"}],"codings":[{"code":"F","display":"Final results","system":"2.16.840.1.113883.12.85"}],"text":"Auth (Verified)"},"effectiveDate":"2011-07-26T20:53:00.000Z","encounter":{"id":"581433f4-b179-3df4-9bb2-9768ef76493c"},"sourceIdentifier":{"dataPartitionId":"e5f34c23-e572-44c3-a2cd-7ca358dcec9f","id":"7209f9fb-3a5d-44c1-8dbb-123f340a9850"},"type":{"sourceCodings":[{"system":"urn:cerner:coding:codingsystem:codeset:72","code":"3374547","display":"Depart Summary"}],"codings":[{"system":"2.16.840.1.113883.6.1","code":"68608-9","display":"Summary note"}],"text":"Depart Summary"},"authors":[{"type":"PROVIDER","provider":{"aliases":[{"system":"2.16.840.1.113883.4.814","value":"2112186","type":"DEA"}],"name":{"prefix":"Dr.","given":["Jane","Susannah"],"family":["Smith"],"suffix":"MD","formatted":"Dr. Jane Susannah Smith MD"}}}],"contents":[{"attachment":{"contentType":{"sourceCodings":[{"code":"text/plain","system":"urn:ietf:bcp:13","display":"text/plain"}],"codings":[{"code":"text/plain","system":"urn:ietf:bcp:13","display":"text/plain"}],"text":"text/plain"},"binary":{"id":"581433f4-b179-3df4-9bb2-9768ef76493c"},"size":"2048000","title":"Physician Emergency Department Note","creation":"2011-07-26T23:53:00.000Z"}}],"aliases":[{"system":"1.1.16.6","value":"2112186"}],"provenances":[{"entities":[{"role":{"sourceCodings":[{"code":"source","system":"2.16.840.1.113883.4.642.1.437","display":"Source"}],"codings":[{"code":"source","system":"2.16.840.1.113883.4.642.1.437","display":"Source"}],"text":"Source"},"what":{"documentReference":{"id":"581433f4-b179-3df4-9bb2-9768ef76493c"}}}],"agents":[{"type":{"sourceCodings":[{"code":"author","system":"2.16.840.1.113883.4.642.1.1131","display":"Author"}],"codings":[{"code":"author","system":"2.16.840.1.113883.4.642.1.1131","display":"Author"}],"text":"Author"},"who":{"organization":{"name":"Rockcreek Clinic","aliases":[{"value":"151579","type":"EXTERNAL","system":"1.2.3.4.5.6.7.8.9.10.1"}]}}}],"recordedOn":"2011-07-26T23:53:00.000Z"}],"securityLabels":[{"sourceCodings":[{"system":"2.16.840.1.113883.5.25","code":"N","display":"normal"}],"codings":[{"system":"2.16.840.1.113883.5.25","code":"N","display":"normal"}],"text":"normal"}]}
GET /populations/{populationId}/patients/{patientId}/document-references/{documentReferenceId}
Retrieves a single document reference for a given patient.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
patientId
path
string
true
N/A
The ID of the patient.
-
populationId
path
string
true
N/A
The ID of the population.
-
documentReferenceId
path
string
true
N/A
The unique ID of the document reference for the patient.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/document-references',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/document-references \
-H 'Authorization: {auth_header}'\
-H 'Accept: application/json'
Example response
{"items":[{"id":"98851171-d7e6-4f51-bdc2-363b8240909f","authenticator":{"type":"PROVIDER","provider":{"aliases":[{"system":"2.16.840.1.113883.12.443","value":"1547428","type":"Admitting"}],"name":{"prefix":"Dr.","given":["Mark","Alexander"],"family":["Joseph"],"suffix":"MD","formatted":"Dr. Mark Alexander Joseph MD"}}},"categories":[{"sourceCodings":[],"codings":[{"system":"2.16.840.1.113883.6.1","code":"LP29684-5","display":"Radiology"}],"concepts":[{"contextId":"a092e06f-7690-4ace-a678-885913a35d46","alias":"RADIOLOGY_REPORT_OBSTYPE"}],"text":"Radiology Report"}],"dateTime":"2019-02-20T19:45:00.000Z","description":"MRI ABDOMEN WITH CONTRAST","docStatus":{"sourceCodings":[{"code":"25","display":"Auth (Verified)","system":"urn:cerner:coding:codingsystem:codeset:8"}],"codings":[{"code":"F","display":"Final results","system":"2.16.840.1.113883.12.85"}],"text":"Auth (Verified)"},"effectivePeriod":{"start":"2019-02-20T19:45:00.000Z","end":"2019-02-21T20:55:00.000Z"},"encounter":{"id":"069a30bf-ff98-38b5-a723-c1c2ecc287a5"},"sourceIdentifier":{"dataPartitionId":"e5f34c23-e572-44c3-a2cd-7ca358dcec9f","id":"25531559-0b77-4b76-bc75-0ff2cd8c6f06"},"type":{"sourceCodings":[{"system":"2.16.840.1.113883.6.1","code":"68604-8","display":"Radiology Diagnostic study note"}],"codings":[{"system":"2.16.840.1.113883.6.1","code":"68604-8","display":"Radiology Diagnostic study note"}],"text":"Radiology Diagnostic study note"},"authors":[{"type":"PROVIDER","provider":{"aliases":[{"system":"2.16.840.1.113883.4.6","value":"1497758121","type":"NPI"}],"name":{"prefix":"Dr.","given":["Mark","Alexander"],"family":["Joseph"],"suffix":"MD","formatted":"Dr. Mark Alexander Joseph MD"}}}],"contents":[{"format":{"sourceCodings":[{"code":"urn:ihe:rad:PDF","system":"1.3.6.1.4.1.19376.1.2.7.1","display":"XDS-I PDF (XDS-I)"}],"codings":[{"code":"urn:ihe:rad:PDF","system":"1.3.6.1.4.1.19376.1.2.7.1","display":"XDS-I PDF (XDS-I)"}],"text":"XDS-I PDF (XDS-I)"},"attachment":{"contentType":{"sourceCodings":[{"code":" application/pdf","system":"urn:ietf:bcp:13","display":" application/pdf"}],"codings":[{"code":" application/pdf","system":"urn:ietf:bcp:13","display":" application/pdf"}],"text":"application/pdf"},"binary":{"id":"681433f4-b174-3df4-9bb1-9768ef76474d"},"size":"2048000","title":"MRI ABDOMEN WITH CONTRAST","creation":"2019-02-21T20:55:00.000Z"}}],"aliases":[{"system":"1.1.16.6","value":"1547428"}],"provenances":[{"entities":[{"role":{"sourceCodings":[{"code":"source","system":"2.16.840.1.113883.4.642.1.437","display":"Source"}],"codings":[{"code":"source","system":"2.16.840.1.113883.4.642.1.437","display":"Source"}],"text":"Source"},"what":{"documentReference":{"id":"a07aa74e-41b4-485a-b9be-b08c383db763"}}}],"agents":[{"type":{"sourceCodings":[{"code":"author","system":"2.16.840.1.113883.4.642.1.1131","display":"Author"}],"codings":[{"code":"author","system":"2.16.840.1.113883.4.642.1.1131","display":"Author"}],"text":"Author"},"who":{"organization":{"name":"Rockcreek Clinic","aliases":[{"value":"151579","type":"EXTERNAL","system":"1.2.3.4.5.6.7.8.9.10.1"}]}}}],"recordedOn":"2019-02-21T20:55:00.000Z"}],"securityLabels":[{"sourceCodings":[{"system":"2.16.840.1.113883.5.25","code":"N","display":"normal"}],"codings":[{"system":"2.16.840.1.113883.5.25","code":"N","display":"normal"}],"text":"normal"}]},{"id":"581433f4-b179-3df4-9bb2-9768ef76493c","authenticator":{"type":"PROVIDER","provider":{"aliases":[{"system":"2.16.840.1.113883.4.814","value":"2112186","type":"DEA"}],"name":{"prefix":"Dr.","given":["Jane","Susannah"],"family":["Smith"],"suffix":"MD","formatted":"Dr. Jane Susannah Smith MD"}}},"categories":[{"sourceCodings":[],"codings":[{"system":"http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category","code":"clinical-note","display":"Clinical Note"}],"concepts":[{"contextId":"a092e06f-7690-4ace-a678-885913a35d46","alias":"CLINICAL_NOTE_OBSTYPE"}],"text":"Clinical Note"}],"dateTime":"2011-07-26T23:53:00.000Z","description":"Physician Emergency Department Note","docStatus":{"sourceCodings":[{"code":"25","display":"Auth (Verified)","system":"urn:cerner:coding:codingsystem:codeset:8"}],"codings":[{"code":"F","display":"Final results","system":"2.16.840.1.113883.12.85"}],"text":"Auth (Verified)"},"effectiveDate":"2011-07-26T20:53:00.000Z","encounter":{"id":"581433f4-b179-3df4-9bb2-9768ef76493c"},"sourceIdentifier":{"dataPartitionId":"e5f34c23-e572-44c3-a2cd-7ca358dcec9f","id":"7209f9fb-3a5d-44c1-8dbb-123f340a9850"},"type":{"sourceCodings":[{"system":"urn:cerner:coding:codingsystem:codeset:72","code":"3374547","display":"Depart Summary"}],"codings":[{"system":"2.16.840.1.113883.6.1","code":"68608-9","display":"Summary note"}],"text":"Depart Summary"},"authors":[{"type":"PROVIDER","provider":{"aliases":[{"system":"2.16.840.1.113883.4.814","value":"2112186","type":"DEA"}],"name":{"prefix":"Dr.","given":["Jane","Susannah"],"family":["Smith"],"suffix":"MD","formatted":"Dr. Jane Susannah Smith MD"}}}],"contents":[{"attachment":{"contentType":{"sourceCodings":[{"code":"text/plain","system":"urn:ietf:bcp:13","display":"text/plain"}],"codings":[{"code":"text/plain","system":"urn:ietf:bcp:13","display":"text/plain"}],"text":"text/plain"},"binary":{"id":"581433f4-b179-3df4-9bb2-9768ef76493c"},"size":"2048000","title":"Physician Emergency Department Note","creation":"2011-07-26T23:53:00.000Z"}}],"aliases":[{"system":"1.1.16.6","value":"2112186"}],"provenances":[{"entities":[{"role":{"sourceCodings":[{"code":"source","system":"2.16.840.1.113883.4.642.1.437","display":"Source"}],"codings":[{"code":"source","system":"2.16.840.1.113883.4.642.1.437","display":"Source"}],"text":"Source"},"what":{"documentReference":{"id":"581433f4-b179-3df4-9bb2-9768ef76493c"}}}],"agents":[{"type":{"sourceCodings":[{"code":"author","system":"2.16.840.1.113883.4.642.1.1131","display":"Author"}],"codings":[{"code":"author","system":"2.16.840.1.113883.4.642.1.1131","display":"Author"}],"text":"Author"},"who":{"organization":{"name":"Rockcreek Clinic","aliases":[{"value":"151579","type":"EXTERNAL","system":"1.2.3.4.5.6.7.8.9.10.1"}]}}}],"recordedOn":"2011-07-26T23:53:00.000Z"}],"securityLabels":[{"sourceCodings":[{"system":"2.16.840.1.113883.5.25","code":"N","display":"normal"}],"codings":[{"system":"2.16.840.1.113883.5.25","code":"N","display":"normal"}],"text":"normal"}]}],"firstLink":"https://cernerdemo.api.us.healtheintent.com/longitudinal-record/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/document-references?limit=20","nextLink":"https://cernerdemo.api.us.healtheintent.com/longitudinal-record/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/document-references?cursor=581433f4-b179-3df4-9bb2-9768ef76493c&limit=20"}
GET /populations/{populationId}/patients/{patientId}/document-references
Retrieves a list of the document references for a given patient.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
patientId
path
string
true
N/A
The ID of the patient.
-
populationId
path
string
true
N/A
The ID of the population.
-
cursor
query
string
false
0
A marker indicating the position of the last item retrieved for a response. If you specify this parameter, the response begins with the next item on the list.
-
limit
query
integer(int32)
false
20
The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.
-
category
query
array[string]
false
N/A
The alias values for category concepts by which results should be filtered.
A binary represents the data of a single raw artifact as digital content accessible in its native format. A binary resource can contain any content, whether text, image, .PDF file, .ZIP file, and so on.
Retrieve a Binary
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/binaries/bc5769fa-ffc0-11e7-a3d6-46705f8c9e89',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/binaries/bc5769fa-ffc0-11e7-a3d6-46705f8c9e89 \
-H 'Authorization: {auth_header}'\
-H 'Accept: application/json'
GET /populations/{populationId}/patients/{patientId}/binaries/{binaryId}
Retrieves a binary for a given patient.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
patientId
path
string
true
N/A
The ID of the patient.
-
populationId
path
string
true
N/A
The ID of the population.
-
binaryId
path
string
true
N/A
The ID that uniquely identifies the binary for the patient.
An exclusion represents a request to remove a patient from the population for a given time period.
Create a Patient Exclusion
Example Request:
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/{populationId}/patients/{patientId}/patient-exclusions',headers: headers,body: {"effectivePeriod":{"startDate":"2020-04-03T09:38:25Z","endDate":"2020-04-23T09:38:25Z"},"tags":[{"key":"Reason","value":"Exclusion requested by patient."},{"key":"Service Account Id:","value":"4d64985f-1146-4a07-a4b8-f6b5e1fabcb2"}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/{populationId}/patients/{patientId}/patient-exclusions \
-H 'Authorization: {auth_header}'\
-H 'Content-Type: application/json'\ \
-H 'Accept: application/json'\
-d {"effectivePeriod":{"startDate":"2020-04-03T09:38:25Z","endDate":"2020-04-23T09:38:25Z"},"tags":[{"key":"Reason","value":"Exclusion requested by patient."},{"key":"Service Account Id:","value":"4d64985f-1146-4a07-a4b8-f6b5e1fabcb2"}]}
Example response
{"id":"c6de50dc-1a6e-4b39-b5ad-ddb8a858da95","patient":{"id":"1b765525-ce26-4a59-ae09-fb0808f991c3","aliases":[{"value":"1831176690","computationalValue":"1831176690","renderedValue":"1831-176690","system":"1.2.3.4.5.6.7.8.9.10.1","type":{"sourceCodings":[{"system":"2.16.840.1.113883.12.203","code":"MR","display":"Medical record number"}],"codings":[{"system":"2.16.840.1.113883.12.203","code":"MR","display":"Medical record number"}],"text":"Medical record number"}}]},"effectivePeriod":{"start":"2019-02-20T19:45:00.000Z","end":"2019-02-21T20:55:00.000Z"},"recordedOn":"2019-02-21T11:55:00.000Z","tags":[{"key":"Reason","value":"Exclusion requested by patient"},{"key":"Service Account Id:","value":"4d64985f-1146-4a07-a4b8-f6b5e1fabcb2"}]}
POST /populations/{populationId}/patients/{patientId}/patient-exclusions
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/{populationId}/patients/{patientId}/patient-exclusions/{exclusionId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/{populationId}/patients/{patientId}/patient-exclusions/{exclusionId}\
-H 'Authorization: {auth_header}'\
-H 'Accept: application/json'
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Content-Type'=>'application/json','Accept'=>'application/json'}result=HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/{populationId}/patients/{patientId}/patient-exclusions/{exclusionId}',headers: headers,body: {"effectivePeriod":{"start":"2020-04-03T09:38:25Z","end":"2020-04-23T09:38:25Z"},"tags":[{"key":"Reason","value":"Exclusion requested by patient."},{"key":"Service Account Id:","value":"4d64985f-1146-4a07-a4b8-f6b5e1fabcb2"}]}.to_json)printJSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/{populationId}/patients/{patientId}/patient-exclusions/{exclusionId}\
-H 'Authorization: {auth_header}'\
-H 'Content-Type: application/json'\ \
-H 'Accept: application/json'\
-d {"effectivePeriod":{"start":"2020-04-03T09:38:25Z","end":"2020-04-23T09:38:25Z"},"tags":[{"key":"Reason","value":"Exclusion requested by patient."},{"key":"Service Account Id:","value":"4d64985f-1146-4a07-a4b8-f6b5e1fabcb2"}]}
Example response
{"id":"c6de50dc-1a6e-4b39-b5ad-ddb8a858da95","patient":{"id":"1b765525-ce26-4a59-ae09-fb0808f991c3","aliases":[{"value":"1831176690","computationalValue":"1831176690","renderedValue":"1831-176690","system":"1.2.3.4.5.6.7.8.9.10.1","type":{"sourceCodings":[{"system":"2.16.840.1.113883.12.203","code":"MR","display":"Medical record number"}],"codings":[{"system":"2.16.840.1.113883.12.203","code":"MR","display":"Medical record number"}],"text":"Medical record number"}}]},"effectivePeriod":{"start":"2019-02-20T19:45:00.000Z","end":"2019-02-21T20:55:00.000Z"},"recordedOn":"2019-02-21T11:55:00.000Z","tags":[{"key":"Reason","value":"Exclusion requested by patient"},{"key":"Service Account Id:","value":"4d64985f-1146-4a07-a4b8-f6b5e1fabcb2"}]}
PUT /populations/{populationId}/patients/{patientId}/patient-exclusions/{exclusionId}
Updating the patient exclusion fully replaces the existing patient exclusion with the revised patient exclusion. For example, if the effective period changes, then all tags must be sent. Otherwise any missing tags are assumed to be deleted. Likewise, if tags change, the effective period must also be sent. Within the effective period, the start date is required, but the end date is optional. When the end date is not valued, it means that the effective period is ongoing and that the exclusion is indefinite.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/{populationId}/patients/{patientId}/patient-exclusions/{exclusionId}',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/{populationId}/patients/{patientId}/patient-exclusions/{exclusionId}\
-H 'Authorization: {auth_header}'\
-H 'Accept: application/json'
Example response
{"id":"c6de50dc-1a6e-4b39-b5ad-ddb8a858da95","patient":{"id":"1b765525-ce26-4a59-ae09-fb0808f991c3","aliases":[{"value":"1831176690","computationalValue":"1831176690","renderedValue":"1831-176690","system":"1.2.3.4.5.6.7.8.9.10.1","type":{"sourceCodings":[{"system":"2.16.840.1.113883.12.203","code":"MR","display":"Medical record number"}],"codings":[{"system":"2.16.840.1.113883.12.203","code":"MR","display":"Medical record number"}],"text":"Medical record number"}}]},"effectivePeriod":{"start":"2019-02-20T19:45:00.000Z","end":"2019-02-21T20:55:00.000Z"},"recordedOn":"2019-02-21T11:55:00.000Z","tags":[{"key":"Reason","value":"Exclusion requested by patient"},{"key":"Service Account Id:","value":"4d64985f-1146-4a07-a4b8-f6b5e1fabcb2"}]}
GET /populations/{populationId}/patients/{patientId}/patient-exclusions/{exclusionId}
An exclusion represents a request to remove a patient from the population for a given time period.
require'httparty'# Using HTTParty 0.16.2require'json'headers={'Authorization'=>'<auth_header>','Accept'=>'application/json'}result=HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/{populationId}/patient-exclusions',headers: headers)printJSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/longitudinal-record/v1/populations/{populationId}/patient-exclusions \
-H 'Authorization: {auth_header}'\
-H 'Accept: application/json'
Example response
{"items":[{"id":"c6de50dc-1a6e-4b39-b5ad-ddb8a858da95","patient":{"id":"1b765525-ce26-4a59-ae09-fb0808f991c3","aliases":[{"value":"1831176692","computationalValue":"1831176692","renderedValue":"1831-176692","system":"1.2.3.4.5.6.7.8.9.10.1","type":{"sourceCodings":[{"system":"2.16.840.1.113883.12.203","code":"MR","display":"Medical record number"}],"codings":[{"system":"2.16.840.1.113883.12.203","code":"MR","display":"Medical record number"}],"text":"Medical record number"}}]},"effectivePeriod":{"start":"2019-02-20T19:45:00.000Z","end":"2019-02-21T20:55:00.000Z"},"recordedOn":"2019-02-21T11:55:00.000Z","tags":[{"key":"Reason","value":"Exclusion requested by patient"},{"key":"Service Account Id:","value":"4d64985f-1146-4a07-a4b8-f6b5e1fabcb2"}]},{"id":"3a54ebb5-5a77-42a1-9582-edf60606fb79","patient":{"id":"601f9450-4f7e-4ff8-849e-95f22e7839c2","aliases":[{"value":"1831176693","computationalValue":"1831176693","renderedValue":"1831-176693","system":"1.2.3.4.5.6.7.8.9.10.1","type":{"sourceCodings":[{"system":"2.16.840.1.113883.12.203","code":"MR","display":"Medical record number"}],"codings":[{"system":"2.16.840.1.113883.12.203","code":"MR","display":"Medical record number"}],"text":"Medical record number"}}]},"effectivePeriod":{"start":"2019-02-20T19:45:00.000Z","end":"2019-02-28T21:55:00.000Z"},"recordedOn":"2019-02-21T11:55:00.000Z","tags":[{"key":"Reason","value":"Exclusion requested by patient."},{"key":"Service Account Id:","value":"4d64985f-1146-4a07-a4b8-f6b5e1fabcb2"}]},{"id":"aae9c1d6-b9ac-4767-b8f1-22526815d6d6","patient":{"id":"b5e79969-98ae-4fa1-a55e-d872762c3f88","aliases":[{"value":"1831176691","computationalValue":"1831176691","renderedValue":"1831-176691","system":"1.2.3.4.5.6.7.8.9.10.1","type":{"sourceCodings":[{"system":"2.16.840.1.113883.12.203","code":"MR","display":"Medical record number"}],"codings":[{"system":"2.16.840.1.113883.12.203","code":"MR","display":"Medical record number"}],"text":"Medical record number"}}]},"effectivePeriod":{"start":"2019-02-20T19:45:00.000Z","end":"2019-02-28T21:55:00.000Z"},"recordedOn":"2019-02-21T21:55:00.000Z","tags":[{"key":"Reason","value":"Exclusion requested by patient."},{"key":"Service Account Id:","value":"4d64985f-1146-4a07-a4b8-f6b5e1fabcb2"}]}]}
GET /populations/{populationId}/patient-exclusions
Retrieves a list of patient exclusions in a population. There are multiple optional query parameters that can be specified, each one adds to how the list of exclusions is returned. When multiple query parameters of the same type are sent, the exclusions returned are those that contain any of them. For example, when multiple tag query parameters are sent (tag1, tag2 and tag3), then those exclusions containing one or more of those tags are returned. Likewise, the same is true for aliases. When multiple query parameters of different types are sent, the exclusions returned must contain any of the first type, as well as any of the second type and so on. For example, if tag1 and tag2 are sent alongside alias1 and alias2, then the exclusions returned must contain either tag1 or tag2 and also either alias1 or alias2.
Parameters
Parameter
In
Type
Required
Default
Description
Accepted Values
tag
query
array[string]
false
N/A
The colon-delimited combination of the key and value of a tag (for example, Reason:Exclusion requested by patient). This query parameter can be repeated multiple times to query for patient exclusions containing a combination of more than one tag. When multiple tags are provided, the results include patient exclusions with one of the tags provided. A patient exclusion can have a maximum of ten tags.
-
alias
query
array[string]
false
N/A
A list of IDs for the patient that are intended to facilitate interoperability among systems. Aliases, such as a medical record number (MRN) or a Social Security number (SSN), are commonly used to uniquely identify the individual. An alias consists of the system and value concatenated together with a vertical bar (|). To ensure the correct identification of an alias, the value and system must be an exact match. If a vertical bar occurs in either the system or value, it must be escaped using an escape character (\). For example, system\|withVerticalBar|value. If an escape character occurs in either the system or value, it must also be escaped using an escape character. For example, system\\withEscape|value.
-
patientId
query
string
false
N/A
An ID representing the patient that is being searched.
-
populationId
path
string
true
N/A
The ID of the population.
-
cursor
query
string
false
0
A marker indicating the position of the last item retrieved for a response. If you specify this parameter, the response begins with the next item on the list.
-
limit
query
integer(int32)
false
20
The maximum number of results to display per page. The minimum limit is one. The maximum limit is 100.
The period of time during which the exclusion is applied and the patient is removed from the population. When the end date is not valued, it means the effective period is ongoing and the exclusion is indefinite.
-
» start
string
true
The date when the patient exclusion began. In International Organization for Standardization (ISO) 8601, formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ
-
» end
string
false
The date when the patient exclusion ended. In ISO 8601, formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ When the end date is not valued, it means the effective period is ongoing and the exclusion is indefinite.
-
tags
[object]
false
Tags used for searching and grouping patient exclusions. Tags are limited to a maximum of 10 per patient exclusion.
-
» key
string
true
The tag key to search for. Searches must include exact matches. A tag must have a key and the key must be unique.
-
» value
string
false
The tag value to search for. Searches must include exact matches. A tag can optionally have a key.
-
PatientExclusion
Name
Type
Required
Description
Accepted Values
id
string
true
The unique ID that identifies the patient exclusion.
The period of time during which the exclusion is applied and the patient is removed from the population. When the end date is not valued, it means the effective period is ongoing and the exclusion is indefinite.
-
recordedOn
string
true
The date when the patient exclusion was added in the system. In ISO 8601, precision formatted to YYYY-MM-DDThh:mm:ss.SSSZ
A list of IDs for the patient that are intended to facilitate interoperability among systems and to commonly and uniquely identify the individual.
-
PatientAlias
Name
Type
Required
Description
Accepted Values
value
string
true
The ID issued by the assigning authority. The formatting may vary by source or alias type.
-
computationalValue
string
false
The formatted version of the alias value that is unique in the system and can be used for computational mapping. For example, removing nonsignificant whitespace, dashes, and so on.
-
renderedValue
string
false
The rendered version of the alias value intended for human display. For example, a sensitive ID (such as an SSN) partially obscured by asterisks or a driver’s license number with dashes inserted.
-
system
string
true
The authority responsible for assigning the alias value. Alias values may be unique in each system, but not across systems. For example, an MRN with a value of 12345 in one hospital’s system may represent a different person than MRN 12345 in a different hospital’s system. HealtheIntent avoids identity collisions by indicating the authority that assigned the alias. Ignoring the assigning authority presents security and data integrity concerns. For example, data being associated with the wrong patient or record.
The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by HealtheIntent.
-
text
string
false
This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list.
-
Code
Name
Type
Required
Description
Accepted Values
code
string
true
The unique ID of the code.
-
display
string
false
A human-readable representation of the code.
-
system
string
true
The ID of the coding system that gives meaning to the code.
-
Tag
Name
Type
Required
Description
Accepted Values
key
string
true
The tag key to search for. The search will be on exact matches.
-
value
string
false
The tag value to search for. The search will be on exact matches.
-
Period
Name
Type
Required
Description
Accepted Values
start
string
false
The start date of the period. In ISO 8601, formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ.
-
end
string
false
The end date of the period. In ISO 8601, formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ.
-
Error
Name
Type
Required
Description
Accepted Values
code
integer(int32)
true
The HTTP response status code that represents the error.
The period of time during which the exclusion is applied and the patient is removed from the population. When the end date is not valued, it means the effective period is ongoing and the exclusion is indefinite.
-
» start
string
true
The date when the patient exclusion began. In ISO 8601, formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ
-
» end
string
false
The date when the patient exclusion ended. In ISO 8601, formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ When the end date is not valued, it means the effective period is ongoing and the exclusion is indefinite.
-
tags
[object]
false
Tags used for searching and grouping patient exclusions. Tags are limited to a maximum of 10 per patient exclusion.
-
» key
string
true
The tag key to search for. The search will be on exact matches. A tag must have a key and the key must be unique.
-
» value
string
false
The tag value to search for. The search will be on exact matches. A tag value must have a key. A tag may optionally include a value.
The status of the document, such as preliminary or final.
-
effectiveDate
string
false
The clinically significant date and time when the service that is described by the document was provided. In International Organization for Standardization (ISO) 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. For a given documentReference, either effectiveDate or effectivePeriod is valued.
The clinically significant time period over which the service that is described by the document was provided. For a given documentReference, either effectiveDate or effectivePeriod is valued.
The business identifiers by which the document or report is known, such as the Digital Imaging and Communications in Medicine (DICOM) study instance unique identifier (UID) or accession number for diagnostic reports.
The record-keeping assertions about the context in which the information in this document reference was obtained (for example, the authoring organization, the transmitter or custodian organization that informs the chain of custody, or the source CCDA document from which this document reference was derived, if applicable).
A set of Security-Tag codes specifying the level of privacy or security of the document. This represents a snapshot of the security labels on the document the reference refers to.
-
Authenticator
Name
Type
Required
Description
Accepted Values
type
string
false
The kind of entity that authenticates or signs the document conveying that the document is valid.
The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems.
-
value
string
false
The unique ID of the provider in the context of the system or assigning authority.
-
type
string
true
The type of alias.
DEA, EXTERNAL, NPI, SL, TAX, UPIN
ProviderName
Name
Type
Required
Description
Accepted Values
prefix
string
false
The parts that come before the name such as Dr., Mr., or Mrs.
-
given
[string]
true
A list of given name portions of the person’s name. For example, if a person has a first name and a middle name, the first name should be the first item on the list and the middle name should be the second item on the list.
-
family
[string]
true
A list of family (last) name portions of the person’s name. Some people have multiple family names.
-
suffix
string
false
The parts that come after the name such as MD, III, or Jr.
-
formatted
string
false
The person’s fully-formatted name.
-
EncounterId
Name
Type
Required
Description
Accepted Values
id
string
false
The unique ID of the encounter.
-
SourceIdentifier
Name
Type
Required
Description
Accepted Values
dataPartitionId
string
false
The ID of the data partition. See the Data Partitions endpoint of the Data Source API for more information.
-
id
string
false
An ID that uniquely identifies this document reference for a patient in a data partition.
-
Author
Name
Type
Required
Description
Accepted Values
type
string
false
The kind of entity that was responsible for adding information to the document.
