FHIR DSTU2

These endpoints are a partial implementation of the FHIR DSTU2 specification. We will consider expanding these and adding additional FHIR endpoints, as well as future versions, based on usage and requests from API users. Please note that these endpoints do not follow the same naming conventions as many of the other APIs offered. Note: If you are accessing a practice without Communicator Brands and are using one of the endpoints that require BRANDID in the path, you can use any positive integer for BRANDID.

 

API Coverage

This section documents the following endpoints:


GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationStatement

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Observation/Vital-{vitalid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Medication/{medicationid}

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/DiagnosticReport/{labresultid}

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Condition

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Organization/Practice-{practiceid}

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient/{patientid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Practitioner/Provider-{providerid}

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/AllergyIntolerance/{allergyintoleranceid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Condition/Problem-{conditionid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Immunization

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/CarePlan/CareTeam-{careteamid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/DocumentReference/AmbulatorySummary-{patientid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationStatement/{medicationstatementid}

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Procedure

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationStatement

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationOrder

POST /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient/{patientid}/$health-cards-issue

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationOrder/{medicationorderid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Device/{deviceid}

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Observation/Vital-{vitalid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Observation

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationAdministration

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Encounter

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/DiagnosticReport/{labresultid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/CarePlan/AssessPlan-{assessplanid}

POST /v1/{practiceid}/{departmentid}/fhir/dstu2/Patient/{patientid}/$health-cards-issue

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Substance/{substanceid}

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Immunization/HistoricalVaccine-{immunizationid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/AllergyIntolerance

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Condition

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/DiagnosticReport

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationOrder/{medicationorderid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Encounter/{encounterid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Procedure

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Observation/SocialHistory-{socialhistoryid}

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Procedure/{procedureid}

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationStatement/{medicationstatementid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationAdministration/{medicationadministrationid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Immunization/ClinicalVaccine-{immunizationid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Immunization/HistoricalVaccine-{immunizationid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Patient

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Observation

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Appointment

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/DiagnosticReport

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Goal/{goalid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationDispense/{medicationdispenseid}

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Immunization

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Observation/ResultObservation-{resultobservationid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Device

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationOrder

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Organization/ClinicalProvider-{clinicalproviderid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Procedure/{procedureid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/ClinicalImpression

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/CarePlan

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Appointment/{appointmentid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Observation/ResultObservation-{resultobservationid}

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Medication/{medicationid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/AllergyIntolerance/{allergyintoleranceid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Goal

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Condition/Problem-{conditionid}

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Immunization/ClinicalVaccine-{immunizationid}

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationDispense

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/AllergyIntolerance

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/DocumentReference

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Patient/{patientid}

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationStatement

List of MedicationStatement resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
identifier string External identifier
 
patient object Who is/was taking the medication
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string active | completed | entered-in-error(Not Supported) | intended(Not Supported)
effectiveperiod object Over what period was medication consumed?
 
start string Starting time with inclusive boundary
end string End time with inclusive boundary, if not ongoing
medicationreference object What medication was taken
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
dosage string Details of how medication was taken
 
text string Reported dosage information
timing object When/how often was medication taken
 
repeat object When the event is to occur
 
frequency integer Event occurs frequency times per period
periodunits string s | min | h | d | wk | mo | a - unit of time (UCUM)
period number Event occurs frequency times per period
event string When the event occurs
 
route object How the medication entered the body
 
text string Dosage Route Text
coding object Dosage Route Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
contained object Medication contained in statement
 
resourcetype string The type of resource
id string ID
code object Medication Code
 
text string Code Text
coding object Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Observation/Vital-{vitalid}

Observation (vital sign) resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who and/or what this is about
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string registered | preliminary | final | amended | cancelled | entered-in-error | unknown
category object Classification of type of observation
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
encounter object Healthcare event during which this observation is made
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
code object Type of observation (code / type)
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
effectivedatetime string Clinically relevant time/time-period for observation
valuequantity object Actual result
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
dataabsentreason object Why the result is missing
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Medication/{medicationid}

Medication resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
code object Codes that identify this medication
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/DiagnosticReport/{labresultid}

DiagnosticReport resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
result string Observations - simple, or complex nested groups
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
subject object The subject of the report, usually, but not always, the patient
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string registered | partial | final | corrected | appended | cancelled | entered-in-error
category object Service category
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
code object Name/Code for this diagnostic report
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
performer object Responsible Diagnostic Service
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
issued string DateTime this version was released
effectivedatetime string Clinically Relevant time/time-period for report

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Condition

List of Condition resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
patient object Who has the condition?
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
asserter object Person who asserts this condition
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
onsetdatetime string Estimated or actual date, date-time, or age
daterecorded string When first entered
category object complaint | symptom | finding | diagnosis
 
coding object Condition Category Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
code object Identification of the condition, problem or diagnosis
 
text string Condition Text
coding object Condition Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
clinicalstatus string active | relapse | remission | resolved
verificationstatus string provisional | differential | confirmed | refuted | entered-in-error | unknown
abatementdatetime string If/when in resolution/remission

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient

List of Patient resources from the results of the search. Date filtering does not apply.

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
identifier object An identifier for this patient
 
use string Identifier Use
value string Identifier Value
system string Identifier System
name object A name associated with the patient
 
use string Purpose of this name
given string List of given names for this patient
family string List of family names for this patient
birthdate string The date of birth for the individual
communication string A list of Languages which may be used to communicate with the patient about his or her health
 
language object The language which can be used to communicate with the patient about his or her health
 
text string Language Text
coding object Language Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
preferred boolean Language preference indicator
telecom object A contact detail for the individual
 
use string Use of this telecom - home | work
value string Telecom value
system string Telecom system
address string Addresses for the individual
 
country string Country (can be ISO 3166 3 letter code)
city string Name of city, town etc.
type string postal | physical | both
text string Text representation of the address
use string home | work | temp | old - purpose of this address
state string Sub-unit of country (abbreviations ok)
period string Time period when address was/is in use
district string District name (aka county)
postalcode string Postal code for area
line string Street name, number, direction & P.O. Box etc.
extension string Additional Content defined by implementations
 
url string Identifies the meaning of the extension
valuecodeableconcept object Value of extension
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
gender string male | female | other | unknown

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Organization/Practice-{practiceid}

Get information about this practice

 

Output Parameters

Name Type Description

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient/{patientid}

Returns Patient Information. Date filtering does not apply.

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
identifier object An identifier for this patient
 
use string Identifier Use
value string Identifier Value
system string Identifier System
name object A name associated with the patient
 
use string Purpose of this name
given string List of given names for this patient
family string List of family names for this patient
birthdate string The date of birth for the individual
communication string A list of Languages which may be used to communicate with the patient about his or her health
 
language object The language which can be used to communicate with the patient about his or her health
 
text string Language Text
coding object Language Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
preferred boolean Language preference indicator
telecom object A contact detail for the individual
 
use string Use of this telecom - home | work
value string Telecom value
system string Telecom system
address string Addresses for the individual
 
country string Country (can be ISO 3166 3 letter code)
city string Name of city, town etc.
type string postal | physical | both
text string Text representation of the address
use string home | work | temp | old - purpose of this address
state string Sub-unit of country (abbreviations ok)
period string Time period when address was/is in use
district string District name (aka county)
postalcode string Postal code for area
line string Street name, number, direction & P.O. Box etc.
extension string Additional Content defined by implementations
 
url string Identifies the meaning of the extension
valuecodeableconcept object Value of extension
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
gender string male | female | other | unknown

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Practitioner/Provider-{providerid}

Get an individual provider

 

Output Parameters

Name Type Description

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/AllergyIntolerance/{allergyintoleranceid}

AllergyIntolerance resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
patient object Who the sensitivity is for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
recordeddate string When recorded
status string active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
substance object Substance, (or class) considered to be responsible for risk
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
criticality string CRITL | CRITH | CRITU
reaction string Adverse Reaction Events linked to exposure to substance
 
manifestation object Clinical symptoms/signs associated with the Event
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
severity string Description of the event as a whole
onset string Date(/time) when manifestations showed

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Condition/Problem-{conditionid}

Condition resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
patient object Who has the condition?
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
asserter object Person who asserts this condition
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
onsetdatetime string Estimated or actual date, date-time, or age
daterecorded string When first entered
category object complaint | symptom | finding | diagnosis
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
code object Identification of the condition, problem or diagnosis
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
clinicalstatus string active | relapse | remission | resolved
verificationstatus string provisional | differential | confirmed | refuted | entered-in-error | unknown
abatementdatetime string If/when in resolution/remission

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Immunization

List of Immunization resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
vaccinecode object Vaccine product administered
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
wasnotgiven boolean Flag for whether immunization was given
date string Vaccination administration date
patient object Who was immunized
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
reported boolean Indicates a self-reported record
expirationdate string Vaccine expiration date
status string in-progress | on-hold | completed | entered-in-error | stopped
explanation object Explanation why immunization was not given
 

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/CarePlan/CareTeam-{careteamid}

Care Plan (Care Team) resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
participant object Who's involved in the plan?
 
member object Who is involved
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
role object Type of involvement
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
subject object Who care plan is for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string proposed | draft | active | completed | cancelled
category string Type of plan
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/DocumentReference/AmbulatorySummary-{patientid}

DocumentReference resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who/what is the subject of the document
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
indexed string When this document reference created
meta object Metadata about the resource
 
security string Security Labels applied to this resource
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
tag string Tags applied to this resource
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
lastupdated string When the resource version last changed
versionid string Version specific identifier
profile string Profiles this resource claims to conform to
 
status string current | superseded | entered-in-error
type object Kind of document (LOINC if possible)
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
content string Document referenced
 
format string Format/content rules for the document
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
attachment object Where to access the document
 
url string Uri where the data can be found
size integer Number of bytes of content (if url provided)
language string Human language of the content (BCP-47)
contenttype string Mime type of the content, with charset etc.
title string Label to display in place of the data
data string Data inline, base64ed
hash string Hash of the data (sha-1, base64ed)
creation string Date attachment was first created
docstatus object The status of the underlying document
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
securitylabel string A set of Security-Tag codes specifying the level of privacy/security of the Document
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
description string Human-readable description of the source document
authenticator object Which person or organization authenticates that this document is valid
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationStatement/{medicationstatementid}

MedicationStatement resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
identifier string External identifier
 
patient object Who is/was taking the medication
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string active | completed | entered-in-error | intended
effectiveperiod object Over what period was medication consumed?
 
start string Starting time with inclusive boundary
end string End time with inclusive boundary, if not ongoing
medicationreference object What medication was taken
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
dosage string Details of how medication was taken
 
text string Reported dosage information
timing object When/how often was medication taken
 
repeat object When the event is to occur
 
frequency integer Event occurs frequency times per period
periodunits string s | min | h | d | wk | mo | a - unit of time (UCUM)
period number Event occurs frequency times per period
event string When the event occurs
 
route object How the medication entered the body
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Procedure

List of Procedure resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who the procedure was performed on
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string in-progress | aborted | completed | entered-in-error
code object Identification of the procedure
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
performeddatetime string Date/Period the procedure was performed

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationStatement

List of MedicationStatement resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
identifier string External identifier
 
patient object Who is/was taking the medication
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string active | completed | entered-in-error(Not Supported) | intended(Not Supported)
effectiveperiod object Over what period was medication consumed?
 
start string Starting time with inclusive boundary
end string End time with inclusive boundary, if not ongoing
medicationreference object What medication was taken
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
dosage string Details of how medication was taken
 
text string Reported dosage information
timing object When/how often was medication taken
 
repeat object When the event is to occur
 
frequency integer Event occurs frequency times per period
periodunits string s | min | h | d | wk | mo | a - unit of time (UCUM)
period number Event occurs frequency times per period
event string When the event occurs
 
route object How the medication entered the body
 
text string Dosage Route Text
coding object Dosage Route Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
contained object Medication contained in statement
 
resourcetype string The type of resource
id string ID
code object Medication Code
 
text string Code Text
coding object Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationOrder

List of MedicationOrder resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
identifier string External identifier
 
prescriber object Who ordered the medication(s)
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
patient object Who prescription is for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string active | on-hold | completed | entered-in-error | stopped | draft
encounter object Created during encounter/admission/stay
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
dateended string When prescription was stopped
dosageinstruction string How medication should be taken
 
text string Dosage instructions expressed as text
timing object When medication should be administered
 
repeat object When the event is to occur
 
frequency integer Event occurs frequency times per period
periodunits string s | min | h | d | wk | mo | a - unit of time (UCUM)
period number Event occurs frequency times per period
event string When the event occurs
 
dosequantity object Amount of medication per dose
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
medicationreference object Medication to be taken
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
datewritten string When prescription was authorized
dispenserequest object Medication supply authorization
 
numberofrepeatsallowed integer Number of refills authorized
quantity object Amount of medication to supply per dispense
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
reasonended object Why prescription was stopped
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

POST /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient/{patientid}/$health-cards-issue

Parameters resource that includes one or more verifiable credentials

 

Output Parameters

Name Type Description
resourcetype string The type of resource (Parameters)
parameter string
 
name string verifiableCredential
valuestring string Health card as JWS String

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationOrder/{medicationorderid}

MedicationOrder resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
identifier string External identifier
 
prescriber object Who ordered the medication(s)
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
patient object Who prescription is for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string active | on-hold | completed | entered-in-error | stopped | draft
encounter object Created during encounter/admission/stay
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
dateended string When prescription was stopped
dosageinstruction string How medication should be taken
 
text string Dosage instructions expressed as text
timing object When medication should be administered
 
repeat object When the event is to occur
 
frequency integer Event occurs frequency times per period
periodunits string s | min | h | d | wk | mo | a - unit of time (UCUM)
period number Event occurs frequency times per period
event string When the event occurs
 
dosequantity object Amount of medication per dose
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
medicationreference object Medication to be taken
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
datewritten string When prescription was authorized
dispenserequest object Medication supply authorization
 
numberofrepeatsallowed integer Number of refills authorized
quantity object Amount of medication to supply per dispense
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
reasonended object Why prescription was stopped
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Device/{deviceid}

Device resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
udi string FDA mandated Unique Device Identifier
patient object If the resource is affixed to a person
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
type object What kind of device this is
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Observation/Vital-{vitalid}

Observation (vital sign) resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who and/or what this is about
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string registered | preliminary | final | amended | cancelled | entered-in-error | unknown
category object Classification of type of observation
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
encounter object Healthcare event during which this observation is made
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
code object Type of observation (code / type)
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
effectivedatetime string Clinically relevant time/time-period for observation
valuequantity object Actual result
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
dataabsentreason object Why the result is missing
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Observation

Returns the list of Observations. Date filtering does not apply for the social-history category.

 

Output Parameters

Name Type Description
id string Logical id of this artifact
subject object Who and/or what this is about
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string registered | preliminary | final | amended | cancelled | entered-in-error | unknown
category object Classification of type of observation
 
text string Observation Category
coding object Observation Category Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
encounter object Healthcare event during which this observation is made
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
issued string Date/Time this was made available
valuestring string Actual result
valuequantity object Actual result
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
referencerange string Provides guide for interpretation
 
low object Low Range, if relevant
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
meaning object Indicates the meaning/use of this range
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
high object High Range, if relevant
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
resourcetype string The type of resource
component string Component results
 
valuequantity object Actual component result
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
code object Type of component observation (code / type)
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
code object Type of observation (code / type)
 
text string Observation Code
coding object Observation Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
 
 
effectivedatetime string Clinically relevant time/time-period for observation
dataabsentreason object Why the result is missing
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
valuecodeableconcept object Actual result
 
coding object Observation coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationAdministration

List of MedicationAdministration resources from the results of the search

 

Output Parameters

Name Type Description
id string Logical id of this artifact
prescription object Order administration performed against
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
patient object Who received medication
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
reasongiven string Reason administration performed
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
status string in-progress | on-hold | completed | entered-in-error | stopped
encounter object Encounter administered as part of
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
dosage object Details of how medication was taken
 
text string Dosage Instructions
sitecodeableconcept object Body site administered to
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
quantity object Amount administered in one dose
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
route object Path of substance into body
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
method object How drug was administered
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
reasonnotgiven string Reason administration not performed
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
resourcetype string The type of resource
identifier string External identifier
 
wasnotgiven boolean True if medication not administered
practitioner object Who administered substance
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
effectivetimeperiod object Start and end time of administration
 
start string Starting time with inclusive boundary
end string End time with inclusive boundary, if not ongoing
device string Device used to administer
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
note string Information about the administration
medicationreference object What was administered
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Encounter

Find encounters for a given patient.

 

Output Parameters

Name Type Description

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/DiagnosticReport/{labresultid}

DiagnosticReport resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
result string Observations - simple, or complex nested groups
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
subject object The subject of the report, usually, but not always, the patient
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string registered | partial | final | corrected | appended | cancelled | entered-in-error
category object Service category
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
code object Name/Code for this diagnostic report
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
performer object Responsible Diagnostic Service
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
issued string DateTime this version was released
effectivedatetime string Clinically Relevant time/time-period for report

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/CarePlan/AssessPlan-{assessplanid}

Care Plan (Assessment and Plan) resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who care plan is for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string proposed | draft | active | completed | cancelled
category string Type of plan
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content

 

POST /v1/{practiceid}/{departmentid}/fhir/dstu2/Patient/{patientid}/$health-cards-issue

Parameters resource that includes one or more verifiable credentials

 

Output Parameters

Name Type Description
resourcetype string The type of resource (Parameters)
parameter string
 
name string verifiableCredential
valuestring string Health card as JWS String

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Substance/{substanceid}

Get an individual substance by ID

 

Output Parameters

Name Type Description

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Immunization/HistoricalVaccine-{immunizationid}

Immunization resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
vaccinecode object Vaccine product administered
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
wasnotgiven boolean Flag for whether immunization was given
date string Vaccination administration date
patient object Who was immunized
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
reported boolean Indicates a self-reported record
expirationdate string Vaccine expiration date
status string in-progress | on-hold | completed | entered-in-error | stopped

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/AllergyIntolerance

Returns the full list of AllergyIntolerance resources. Date filtering does not apply.

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
patient object Who the sensitivity is for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
recordeddate string When recorded
onset string Effective date of the allergy
status string active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
substance object Substance, (or class) considered to be responsible for risk
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
criticality string CRITL | CRITH | CRITU
reaction string Adverse Reaction Events linked to exposure to substance
 
manifestation object Clinical symptoms/signs associated with the Event
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
severity string Description of the event as a whole
onset string Date(/time) when manifestations showed

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Condition

List of Condition resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
patient object Who has the condition?
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
asserter object Person who asserts this condition
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
onsetdatetime string Estimated or actual date, date-time, or age
daterecorded string When first entered
category object complaint | symptom | finding | diagnosis
 
coding object Condition Category Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
code object Identification of the condition, problem or diagnosis
 
text string Condition Text
coding object Condition Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
clinicalstatus string active | relapse | remission | resolved
verificationstatus string provisional | differential | confirmed | refuted | entered-in-error | unknown
abatementdatetime string If/when in resolution/remission

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/DiagnosticReport

List of DiagnosticReport resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
result string Observations - simple, or complex nested groups
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
subject object The subject of the report, usually, but not always, the patient
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string registered | partial | final | corrected | appended | cancelled | entered-in-error
category object Service category
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
code object Name/Code for this diagnostic report
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
performer object Responsible Diagnostic Service
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
issued string DateTime this version was released
effectivedatetime string Clinically Relevant time/time-period for report

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationOrder/{medicationorderid}

MedicationOrder resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
identifier string External identifier
 
prescriber object Who ordered the medication(s)
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
patient object Who prescription is for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string active | on-hold | completed | entered-in-error | stopped | draft
encounter object Created during encounter/admission/stay
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
dateended string When prescription was stopped
dosageinstruction string How medication should be taken
 
text string Dosage instructions expressed as text
timing object When medication should be administered
 
repeat object When the event is to occur
 
frequency integer Event occurs frequency times per period
periodunits string s | min | h | d | wk | mo | a - unit of time (UCUM)
period number Event occurs frequency times per period
event string When the event occurs
 
dosequantity object Amount of medication per dose
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
medicationreference object Medication to be taken
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
datewritten string When prescription was authorized
dispenserequest object Medication supply authorization
 
numberofrepeatsallowed integer Number of refills authorized
quantity object Amount of medication to supply per dispense
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
reasonended object Why prescription was stopped
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Encounter/{encounterid}

Get details of a given encounter

 

Output Parameters

Name Type Description

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Procedure

List of Procedure resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who the procedure was performed on
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string in-progress | aborted | completed | entered-in-error
code object Identification of the procedure
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
performeddatetime string Date/Period the procedure was performed

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Observation/SocialHistory-{socialhistoryid}

Observation (social history) resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who and/or what this is about
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string registered | preliminary | final | amended | cancelled | entered-in-error | unknown
category object Classification of type of observation
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
code object Type of observation (code / type)
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
issued string Date/Time this was made available
valuecodeableconcept object Actual result
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Procedure/{procedureid}

Procedure resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who the procedure was performed on
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string in-progress | aborted | completed | entered-in-error
performeddatetime string Date/Period the procedure was performed
code object Identification of the procedure
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/MedicationStatement/{medicationstatementid}

MedicationStatement resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
identifier string External identifier
 
patient object Who is/was taking the medication
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string active | completed | entered-in-error | intended
effectiveperiod object Over what period was medication consumed?
 
start string Starting time with inclusive boundary
end string End time with inclusive boundary, if not ongoing
medicationreference object What medication was taken
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
dosage string Details of how medication was taken
 
text string Reported dosage information
timing object When/how often was medication taken
 
repeat object When the event is to occur
 
frequency integer Event occurs frequency times per period
periodunits string s | min | h | d | wk | mo | a - unit of time (UCUM)
period number Event occurs frequency times per period
event string When the event occurs
 
route object How the medication entered the body
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationAdministration/{medicationadministrationid}

MedicationAdministration resource from given ID

 

Output Parameters

Name Type Description
id string Logical id of this artifact
prescription object Order administration performed against
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
patient object Who received medication
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
reasongiven string Reason administration performed
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
status string in-progress | on-hold | completed | entered-in-error | stopped
encounter object Encounter administered as part of
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
dosage object Details of how medication was taken
 
text string Dosage Instructions
sitecodeableconcept object Body site administered to
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
quantity object Amount administered in one dose
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
route object Path of substance into body
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
method object How drug was administered
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
reasonnotgiven string Reason administration not performed
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
resourcetype string The type of resource
identifier string External identifier
 
wasnotgiven boolean True if medication not administered
practitioner object Who administered substance
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
effectivetimeperiod object Start and end time of administration
 
start string Starting time with inclusive boundary
end string End time with inclusive boundary, if not ongoing
device string Device used to administer
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
note string Information about the administration
medicationreference object What was administered
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Immunization/ClinicalVaccine-{immunizationid}

Immunization resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
vaccinecode object Vaccine product administered
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
wasnotgiven boolean Flag for whether immunization was given
date string Vaccination administration date
patient object Who was immunized
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
reported boolean Indicates a self-reported record
expirationdate string Vaccine expiration date
status string in-progress | on-hold | completed | entered-in-error | stopped

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Immunization/HistoricalVaccine-{immunizationid}

Immunization resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
vaccinecode object Vaccine product administered
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
wasnotgiven boolean Flag for whether immunization was given
date string Vaccination administration date
patient object Who was immunized
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
reported boolean Indicates a self-reported record
expirationdate string Vaccine expiration date
status string in-progress | on-hold | completed | entered-in-error | stopped

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Patient

List of Patient resources from the results of the search. Date filtering does not apply.

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
identifier object An identifier for this patient
 
use string Identifier Use
value string Identifier Value
system string Identifier System
name object A name associated with the patient
 
use string Purpose of this name
given string List of given names for this patient
family string List of family names for this patient
birthdate string The date of birth for the individual
communication string A list of Languages which may be used to communicate with the patient about his or her health
 
language object The language which can be used to communicate with the patient about his or her health
 
text string Language Text
coding object Language Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
preferred boolean Language preference indicator
telecom object A contact detail for the individual
 
use string Use of this telecom - home | work
value string Telecom value
system string Telecom system
address string Addresses for the individual
 
country string Country (can be ISO 3166 3 letter code)
city string Name of city, town etc.
type string postal | physical | both
text string Text representation of the address
use string home | work | temp | old - purpose of this address
state string Sub-unit of country (abbreviations ok)
period string Time period when address was/is in use
district string District name (aka county)
postalcode string Postal code for area
line string Street name, number, direction & P.O. Box etc.
extension string Additional Content defined by implementations
 
url string Identifies the meaning of the extension
valuecodeableconcept object Value of extension
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
gender string male | female | other | unknown

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Observation

Returns the list of Observations. Date filtering does not apply for the social-history category.

 

Output Parameters

Name Type Description
id string Logical id of this artifact
subject object Who and/or what this is about
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string registered | preliminary | final | amended | cancelled | entered-in-error | unknown
category object Classification of type of observation
 
text string Observation Category
coding object Observation Category Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
encounter object Healthcare event during which this observation is made
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
issued string Date/Time this was made available
valuestring string Actual result
valuequantity object Actual result
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
referencerange string Provides guide for interpretation
 
low object Low Range, if relevant
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
meaning object Indicates the meaning/use of this range
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
high object High Range, if relevant
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
resourcetype string The type of resource
component string Component results
 
valuequantity object Actual component result
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
code object Type of component observation (code / type)
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
code object Type of observation (code / type)
 
text string Observation Code
coding object Observation Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
 
 
effectivedatetime string Clinically relevant time/time-period for observation
dataabsentreason object Why the result is missing
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
valuecodeableconcept object Actual result
 
coding object Observation coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Appointment

Find appointments within a practice

 

Output Parameters

Name Type Description

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/DiagnosticReport

List of DiagnosticReport resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
result string Observations - simple, or complex nested groups
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
subject object The subject of the report, usually, but not always, the patient
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string registered | partial | final | corrected | appended | cancelled | entered-in-error
category object Service category
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
code object Name/Code for this diagnostic report
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
performer object Responsible Diagnostic Service
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
issued string DateTime this version was released
effectivedatetime string Clinically Relevant time/time-period for report

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Goal/{goalid}

Goal resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who this goal is intended for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
description string What's the desired outcome

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationDispense/{medicationdispenseid}

MedicationDispense resource from given ID

 

Output Parameters

Name Type Description
id string Logical id of this artifact
destination object Where the medication was sent
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
patient object Who the dispense is for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string in-progress | on-hold | completed | entered-in-error | stopped
quantity object Amount dispensed
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
dosageinstruction string Medicine administration instructions to the patient/caregiver
 
text string Dosage Instructions
additionalinstructions object E.g. "Take with food"
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
timing object When medication should be administered
 
repeat object When the event is to occur
 
frequency integer Event occurs frequency times per period
periodunits string s | min | h | d | wk | mo | a - unit of time (UCUM)
period number Event occurs frequency times per period
event string When the event occurs
 
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
dispenser object Practitioner responsible for dispensing medication
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
resourcetype string The type of resource
identifier string External identifier
type object Trial fill, partial fill, emergency fill, etc.
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
note string Information about the dispense
medicationreference object What medication was supplied
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
receiver string Who collected the medication
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
authorizingprescriptions string Medication order that authorizes the dispense
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
whenhandedover string When product was given out
whenprepared string Dispense processing time
dayssupply object Days Supply
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Immunization

List of Immunization resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
vaccinecode object Vaccine product administered
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
wasnotgiven boolean Flag for whether immunization was given
date string Vaccination administration date
patient object Who was immunized
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
reported boolean Indicates a self-reported record
expirationdate string Vaccine expiration date
status string in-progress | on-hold | completed | entered-in-error | stopped
explanation object Explanation why immunization was not given
 

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Observation/ResultObservation-{resultobservationid}

Observation (laboratory test and result) resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who and/or what this is about
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string registered | preliminary | final | amended | cancelled | entered-in-error | unknown
category object Classification of type of observation
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
code object Type of observation (code / type)
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
valuestring string Actual result
effectivedatetime string Clinically relevant time/time-period for observation
valuecodeableconcept object Actual result
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
referencerange string Provides guide for interpretation
 
low object Low Range, if relevant
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
meaning object Indicates the meaning/use of this range
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
high object High Range, if relevant
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Device

Returns the list of Devices. Date filtering does not apply.

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
udi string FDA mandated Unique Device Identifier
patient object If the resource is affixed to a person
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
type object What kind of device this is
 
text string Device Type
coding object Device Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
model string Device Model
manufacturer string Device Manufacturer

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationOrder

List of MedicationOrder resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
identifier string External identifier
 
prescriber object Who ordered the medication(s)
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
patient object Who prescription is for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string active | on-hold | completed | entered-in-error | stopped | draft
encounter object Created during encounter/admission/stay
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
dateended string When prescription was stopped
dosageinstruction string How medication should be taken
 
text string Dosage instructions expressed as text
timing object When medication should be administered
 
repeat object When the event is to occur
 
frequency integer Event occurs frequency times per period
periodunits string s | min | h | d | wk | mo | a - unit of time (UCUM)
period number Event occurs frequency times per period
event string When the event occurs
 
dosequantity object Amount of medication per dose
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
medicationreference object Medication to be taken
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
datewritten string When prescription was authorized
dispenserequest object Medication supply authorization
 
numberofrepeatsallowed integer Number of refills authorized
quantity object Amount of medication to supply per dispense
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
reasonended object Why prescription was stopped
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Organization/ClinicalProvider-{clinicalproviderid}

Get an individual clinical provider

 

Output Parameters

Name Type Description

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Procedure/{procedureid}

Procedure resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who the procedure was performed on
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string in-progress | aborted | completed | entered-in-error
performeddatetime string Date/Period the procedure was performed
code object Identification of the procedure
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/ClinicalImpression

Find clinical impresssions for a given patient.

 

Output Parameters

Name Type Description

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/CarePlan

List of Care Plan resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
participant object Who's involved in the plan?
 
member object Who is involved
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
role object Type of involvement
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
subject object Who care plan is for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string proposed | draft | active | completed | cancelled
category string Type of plan
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Appointment/{appointmentid}

Get a single appointment

 

Output Parameters

Name Type Description

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Observation/ResultObservation-{resultobservationid}

Observation (laboratory test and result) resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who and/or what this is about
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string registered | preliminary | final | amended | cancelled | entered-in-error | unknown
category object Classification of type of observation
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
code object Type of observation (code / type)
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
valuestring string Actual result
effectivedatetime string Clinically relevant time/time-period for observation
valuecodeableconcept object Actual result
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
referencerange string Provides guide for interpretation
 
low object Low Range, if relevant
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
meaning object Indicates the meaning/use of this range
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
high object High Range, if relevant
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Medication/{medicationid}

Medication resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
code object Codes that identify this medication
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/AllergyIntolerance/{allergyintoleranceid}

AllergyIntolerance resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
patient object Who the sensitivity is for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
recordeddate string When recorded
status string active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
substance object Substance, (or class) considered to be responsible for risk
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
criticality string CRITL | CRITH | CRITU
reaction string Adverse Reaction Events linked to exposure to substance
 
manifestation object Clinical symptoms/signs associated with the Event
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
severity string Description of the event as a whole
onset string Date(/time) when manifestations showed

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Goal

List of Goal resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who this goal is intended for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
description string What's the desired outcome

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Condition/Problem-{conditionid}

Condition resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
patient object Who has the condition?
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
asserter object Person who asserts this condition
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
onsetdatetime string Estimated or actual date, date-time, or age
daterecorded string When first entered
category object complaint | symptom | finding | diagnosis
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
code object Identification of the condition, problem or diagnosis
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
clinicalstatus string active | relapse | remission | resolved
verificationstatus string provisional | differential | confirmed | refuted | entered-in-error | unknown
abatementdatetime string If/when in resolution/remission

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Immunization/ClinicalVaccine-{immunizationid}

Immunization resource from given ID

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
vaccinecode object Vaccine product administered
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
wasnotgiven boolean Flag for whether immunization was given
date string Vaccination administration date
patient object Who was immunized
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
reported boolean Indicates a self-reported record
expirationdate string Vaccine expiration date
status string in-progress | on-hold | completed | entered-in-error | stopped

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/MedicationDispense

List of MedicationDispense resources from the results of the search

 

Output Parameters

Name Type Description
id string Logical id of this artifact
destination object Where the medication was sent
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
patient object Who the dispense is for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
status string in-progress | on-hold | completed | entered-in-error | stopped
quantity object Amount dispensed
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form
dosageinstruction string Medicine administration instructions to the patient/caregiver
 
text string Dosage Instructions
additionalinstructions object E.g. "Take with food"
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
timing object When medication should be administered
 
repeat object When the event is to occur
 
frequency integer Event occurs frequency times per period
periodunits string s | min | h | d | wk | mo | a - unit of time (UCUM)
period number Event occurs frequency times per period
event string When the event occurs
 
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
dispenser object Practitioner responsible for dispensing medication
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
resourcetype string The type of resource
identifier string External identifier
type object Trial fill, partial fill, emergency fill, etc.
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
note string Information about the dispense
medicationreference object What medication was supplied
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
receiver string Who collected the medication
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
authorizingprescriptions string Medication order that authorizes the dispense
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
whenhandedover string When product was given out
whenprepared string Dispense processing time
dayssupply object Days Supply
 
unit string Unit representation
value number Numerical value (with implicit precision)
code string Coded form of the unit
system string System that defines coded unit form

 

GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/AllergyIntolerance

Returns the full list of AllergyIntolerance resources. Date filtering does not apply.

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
patient object Who the sensitivity is for
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
recordeddate string When recorded
onset string Effective date of the allergy
status string active | unconfirmed | confirmed | inactive | resolved | refuted | entered-in-error
substance object Substance, (or class) considered to be responsible for risk
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
text object Text summary of the resource, for human interpretation
 
status string generated | extensions | additional | empty
div string Limited xhtml content
criticality string CRITL | CRITH | CRITU
reaction string Adverse Reaction Events linked to exposure to substance
 
manifestation object Clinical symptoms/signs associated with the Event
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
severity string Description of the event as a whole
onset string Date(/time) when manifestations showed

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/DocumentReference

List of DocumentReference resources from the results of the search

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
subject object Who/what is the subject of the document
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource
indexed string When this document reference created
meta object Metadata about the resource
 
security string Security Labels applied to this resource
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
tag string Tags applied to this resource
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
lastupdated string When the resource version last changed
versionid string Version specific identifier
profile string Profiles this resource claims to conform to
 
status string current | superseded | entered-in-error
type object Kind of document (LOINC if possible)
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
content string Document referenced
 
format string Format/content rules for the document
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
attachment object Where to access the document
 
url string Uri where the data can be found
size integer Number of bytes of content (if url provided)
language string Human language of the content (BCP-47)
contenttype string Mime type of the content, with charset etc.
title string Label to display in place of the data
data string Data inline, base64ed
hash string Hash of the data (sha-1, base64ed)
creation string Date attachment was first created
docstatus object The status of the underlying document
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
securitylabel string A set of Security-Tag codes specifying the level of privacy/security of the Document
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
description string Human-readable description of the source document
authenticator object Which person or organization authenticates that this document is valid
 
reference string Relative, internal or absolute URL reference
display string Text alternative for the resource

 

GET /v1/{practiceid}/{departmentid}/fhir/dstu2/Patient/{patientid}

Returns Patient Information. Date filtering does not apply.

 

Output Parameters

Name Type Description
resourcetype string The type of resource
id string Logical id of this artifact
identifier object An identifier for this patient
 
use string Identifier Use
value string Identifier Value
system string Identifier System
name object A name associated with the patient
 
use string Purpose of this name
given string List of given names for this patient
family string List of family names for this patient
birthdate string The date of birth for the individual
communication string A list of Languages which may be used to communicate with the patient about his or her health
 
language object The language which can be used to communicate with the patient about his or her health
 
text string Language Text
coding object Language Coding
 
text string Plain text representation of the concept
coding string Code defined by a terminology system This is a potentially recursive entry.
preferred boolean Language preference indicator
telecom object A contact detail for the individual
 
use string Use of this telecom - home | work
value string Telecom value
system string Telecom system
address string Addresses for the individual
 
country string Country (can be ISO 3166 3 letter code)
city string Name of city, town etc.
type string postal | physical | both
text string Text representation of the address
use string home | work | temp | old - purpose of this address
state string Sub-unit of country (abbreviations ok)
period string Time period when address was/is in use
district string District name (aka county)
postalcode string Postal code for area
line string Street name, number, direction & P.O. Box etc.
extension string Additional Content defined by implementations
 
url string Identifies the meaning of the extension
valuecodeableconcept object Value of extension
 
text string Plain text representation of the concept
coding string Code defined by a terminology system
 
display string Representation defined by the system
code string Symbol in syntax defined by the system
system string Identity of the terminology system
gender string male | female | other | unknown