API Documentation for PowerSoftMD Certified
Version MU3B
The PowerSoftMD Certified EHR, hereafter referred to as PowerSoftMD or
PowerSoftMD EHR, API documentation provides information for searching and
fetching patient data from the Common Clinical Data Set as defined by the
Meaningful Use 2015 “Stage 3” regulations. The search criteria are intended to
meet the 2015 Edition ONC Certification criterion Patient Selection
170.315(g)(7), Category Search 170.315(g)(8) and All Category Search
170.315(g)(9). Access is based on the HL7 FHIR Data Access Framework (DAF)
profile and draws requirements from DSTU3. Generally, only required DSTU3 data
elements are provided.
PowerSoftMD uses the restful based service architecture which allows seamless
integration over the HTTPS protocol. This means that clients that can
communicate over HTTPS can easily communicate with the API service. Data passed
to the server is supported and provided in XML.
Registration
for API access must be conducted with PowerSoftMD clients.
PowerSoftMD
clients may suspend or revoke an API identifier at its discretion at any time as
a result of a non-conformance. If this happens, you will not be able to
communicate with PowerSoftMD's clients until the non-conformance is resolved.
You may contact PowerSoftMD client office on resolving the problem that led to
the client identifier being suspended.
Direct
access to PowerSoftMD is not required to develop or test your products. Testing
can be done via a sandbox FHIR server. Your access to PowerSoftMD documentation
does not give you permission to access PowerSoftMD, and does not give you permission
to access PowerSoftMD Clients. Your access to PowerSoftMD is only granted by
PowerSoftMD Clients. You must follow the PowerSoftMD FHIR Guidelines, including
compliance to the ONC Certification Criteria.
PowerSoftMD
uses a simple information identification scheme to make finding information
related to a specific patient easier.
Terms of Use
Your
use of this site, including, without limitation, accessing the PowerSoftMD
APIs, is subject to these PowerSoftMD API Terms of Use. PowerSoftMD may update and
modify the PowerSoftMD API Terms of Use at its sole discretion and without
notice. API Developers and other users of this site should regularly check this
site for updates to the PowerSoftMD API Terms of Use. Further, PowerSoftMD
clients may deploy and integrate the API in ways where the client would be able
to layer on its own specific terms of use unique to that organization.
Ownership
PowerSoftMD
retains all ownership of PowerSoftMD property and reserves all of its
applicable rights with respect to the content of this site, PowerSoftMD EHR and
PowerSoftMD APIs. Nothing in the PowerSoftMD API Terms of Use or any
documentation associated with the PowerSoftMD APIs is intended to convey any
transfer of ownership of PowerSoftMD's property.
Source Code or Software
PowerSoftMD
API Developers may test applications by using a FHIR Server Sandbox or by
collaborating with the PowerSoftMD Client office; it is not necessary to access
the PowerSoftMD EHR to test applications. In connection with providing the
PowerSoftMD APIs, PowerSoftMD does not offer a license to use the PowerSoftMD
EHR, or access to the PowerSoftMD EHR to any party that has not purchased a
license to the PowerSoftMD EHR. PowerSoftMD will not make any PowerSoftMD
source code available to any party in connection with the PowerSoftMD APIs.
Indemnity
By
accessing the PowerSoftMD APIs, you assume the risk of liability for, and agree
to indemnify and hold harmless PowerSoftMD and its affiliates, employees,
clients, partners, dealers (collectively, "PowerSoftMD") and will
defend PowerSoftMD from and against any and all liabilities, losses, claims,
damages, claims and expenses (including legal expenses of any kind and nature)
arising out of, or relating to, directly or indirectly: (a) any action or omission
related to (i) your use of the PowerSoftMD APIs or (ii) the development,
content, or performance of third party applications developed by you or (b)
your failure to comply with any federal, state or local laws, rules or
regulations in connection with your use of the PowerSoftMD APIs.
Warranty Disclaimers
PowerSoftMD
APIs are provided on an "as-is" basis with all faults and defects,
and without any warranty whatsoever. The entire risk as to the quality and
performance of the PowerSoftMD APIs is with the third-party Developer.
PowerSoftMD shall be responsible for the performance of PowerSoftMD developed
applications. PowerSoftMD does not provide any service level agreements or
performance objectives for availability, response time or any other performance
measurement associated with the PowerSoftMD APIs.
For
any issues alleged to be caused solely by the PowerSoftMD APIs, API Users may
report issues to PowerSoftMD at support@PowerSoftMD.com. PowerSoftMD will make
reasonable efforts to investigate and correct such issues at its sole
discretion towards the functioning of the PowerSoftMD API as intended.
Fast Healthcare
Interoperability Resources, or FHIR, is a standard way of defining an API for
healthcare resources. More information can be found at the
https://www.hl7.org/FHIR/.
The PowerSoftMD FHIR API
is based on DSTU 3 of the FHIR standard. The PowerSoftMD FHIR API is a RESTful
implementation for an API. FHIR is resource-based. The resources are healthcare
or related resources, such as patient, problems, immunizations or medications.
These resources are
accessed through HTTP to retrieve a resource with a GET. To update a resource a
POST is performed.
The PowerSoftMD FHIR API
supports XML, the Client’s FHIR server may support JSON as well as XML.
Security, Registration,
and Authentication may be dependent on the FHIR Server setup selected by Client
offices and the way they configure it. Check with the client office. The
username and password provided by the client office are passed as “BASIC”
authentication headers on all requests through the TLS encrypted connection to
the clients https web address.
This means the username
and password are concatenated with a colon, base 64 encoded, and prefixed with
“Basic ” (without the quotes,) i.e. “Basic dXNlcm5hbWU6cGFzc3dvcmQ=”
This string is sent as
the Authorization header.
Exceptions
will return an OperationOutcome segment instead of the expected resource, or
for Authorization errors, a completely non XML http error with an eplanation of
what was wrong with the request.
For example, xml response for
non-existent resources is similar to the following:
<OperationOutcome
xmlns="http://hl7.org/fhir"> <issue>
<severity value="error"/> <code
value="processing"/>
<diagnostics value="Resource Patient/FJF0000212311902A is not
known"/> </issue> </OperationOutcome> |
To
retrieve demographic information for the patient with ID 1501, issue the
following GET request:
GET https://your.FHIRserver.com/Patient/1501A
API Endpoints and Syntax
API
Name |
API
Endpoint URL |
Patient
Search |
GET
https://your.FHIRserver.com/Patient?criteria |
Search Criteria |
family=lastname given=firstname birthdate=yyyy-mm-dd |
Search Criteria |
gender=f/m telecom=nnnnnnnnnn address=anypartofaddress |
Search Criteria |
Note: Multiple criteria can be used with
& between criteria |
Search Criteria |
Example:
family=flintstone&given=fred&birthdate=1974-05-15 |
Patient |
GET
https://your.FHIRserver.com/Patient/patientidA |
Problem |
GET
https://your.FHIRserver.com/Condition/patientidBincrement |
Medication |
GET
https://your.FHIRserver.com/Medication/patientidCincrement |
Allergy |
GET
https://your.FHIRserver.com/AllergyIntolerance/patientidDincrement |
LabTests |
GET
https://your.FHIRserver.com/TestScript/patientidKincrement |
LabResults |
GET
https://your.FHIRserver.com/DiagnosticReport/patientidHincrement |
Vital
Signs |
|
Body Temperature |
GET
https://your.FHIRserver.com/Observation/patientidEincrement-1 |
Systolic Blood Pressure |
GET
https://your.FHIRserver.com/Observation/patientidEincrement-2 |
Diastolic Blood Pressure |
GET
https://your.FHIRserver.com/Observation/patientidEincrement-3 |
Body Weight |
GET
https://your.FHIRserver.com/Observation/patientidEincrement-4 |
Body Height |
GET
https://your.FHIRserver.com/Observation/patientidEincrement-5 |
Heart Rate |
GET
https://your.FHIRserver.com/Observation/patientidEincrement-6 |
Respiratory rate |
GET
https://your.FHIRserver.com/Observation/patientidEincrement-7 |
Glucose in Serum/Plasma |
GET
https://your.FHIRserver.com/Observation/patientidEincrement-8 |
Last menstrual period |
GET
https://your.FHIRserver.com/Observation/patientidEincrement-A |
Oxygen saturation |
GET
https://your.FHIRserver.com/Observation/patientidEincrement-B |
Inhaled oxygen concentration |
GET
https://your.FHIRserver.com/Observation/patientidEincrement-C |
Head Occipital circumference |
GET
https://your.FHIRserver.com/Observation/patientidEincrement-D |
Body mass index (BMI) |
GET
https://your.FHIRserver.com/Observation/patientidEincrement-E |
Procedure |
GET
https://your.FHIRserver.com/Procedure/patientidFincrement |
Care
Team |
GET
https://your.FHIRserver.com/Practitioner/patientidNincrement |
Immunization |
GET
https://your.FHIRserver.com/Immunization/patientidGincrement |
Implantable
Devices |
GET
https://your.FHIRserver.com/Device/patientidIincrement |
Implantable
Device Installation |
GET
https://your.FHIRserver.com/ActivityDefinition/patientidIincrement-A |
Assessment
and Plan |
GET
https://your.FHIRserver.com/CarePlan/patientidLincrement |
Goals |
GET
https://your.FHIRserver.com/Goal/patientidJincrement |
Health
Concerns |
GET
https://your.FHIRserver.com/Condition/patientidMincrement |
CCDA
ID List (Returns ccda ids) |
GET
https://your.FHIRserver.com/List/patientidQ |
CCDA |
GET
https://your.FHIRserver.com/Binary/ccdaid |
Examples:
GET
https://your.FHIRserver.com/Patient?name=Jane
GET
https://your.FHIRserver.com/Patient?given=Jane&gender=female
The parameters available
in the search query are dependent on the FHIR Server used. The following
parameters are all available with Hapi FHIR Server:
Name |
Description |
_id |
ID of the patient. |
family |
Portion of the last
name of the patient. |
given |
Portion of the first
or middle name of the patient. |
gender |
Patient's gender. For
more information on this value set, see https://www.hl7.org/FHIR/valueset-administrative-gender.html |
birthdate |
Patient's date of
birth. For more information on this type, see
https://www.hl7.org/FHIR/datatypes.html#date |
telecom |
Patient’s phone number. |
address |
Portion of the patient’s address. |
A patient ID can be used
to query for additional information. The search function is described above.
If the response returns
one or more patients, the response contains the PID (or patient IDs) with a
letter A as a suffix indicating a patient section.
<Bundle
xmlns="http://hl7.org/FHIR">
<type value="searchset"/>
<total value="X"/>
<entry>
<resource>
<Patient
xmlns="http://hl7.org/FHIR">
<id
value="FJF0000212311901A"/>
<language
value="English"/>
<text>
<status
value="generated"/>
</text>
</Patient>
</resource>
<search>
<mode value="match"/>
</search>
</entry>
[...]
</Bundle>
You can now use the PID in subsequent
requests.
The PID can be used to find ALL data
related to the patient.
The patient's PID and
suffix ‘A’ used to retrieve the patient is passed as part of the URL.
GET https://your.FHIRserver.com/Patient/patientidA
Name |
Description |
id |
Patient's PID. This is retrieved using the
search function. |
A Patient record is
returned on the query using the PID and suffix ‘A’. The following table
describes the information returned.
Name |
Description |
identifier |
Patient's PID. Patients are usually assigned a
specific identifier that is unique within the system. |
active |
Is the patient's record active? The default
value is true. Need to be able to mark a patient record as not to be used
because it was created in error. If a record is inactive, and linked to an
active record, then future patient/record updates should occur on the other
patient. |
name |
Names associated with the patient. Can be
multiple returned including prior. |
telecom |
Patient contact communication detail. This
indicates the value in any kind of telecom details field for the patient. |
gender |
Patient's gender. Returns Male, Female, Other,
or Unknown. Patient's gender. For more information on this value set, see https://www.hl7.org/FHIR/valueset-administrative-gender.html |
birthDate |
Patient's date of birth. |
address |
Patient's postal address. Postal addresses are
often used to record a location that can be visited to find a patient or
person. |
communication |
Patient’s preferred
language. |
extension |
Information not explicitly included in the
FHIR standard. Includes Race, Ethnicity, and Smoking Status. |
The xml response is
similar to the following:
<Patient
xmlns="http://hl7.org/FHIR"> <id
value="FJF0000212311901A"/> <language
value="English"/> <extension
url="2.16.840.1.113883.6.238"> <valueExtension> <valueCode
value="1002-5"/> </valueExtension> </extension> <extension url="2.16.840.1.113883.6.238"> <valueExtension> <valueCode
value="2054-5"/> </valueExtension> </extension> <extension
url="2.16.840.1.113883.6.238"> <valueExtension> <valueCode
value="2135-2"/> </valueExtension> </extension> <extension
url="2.16.840.1.113883.10.20.22.2.17"> <valueExtension> <valueCode
value="428061000124105"/> </valueExtension> </extension> <active value="true"/> <name> <use value="official"/> <text value="FRED J
FLINTSTONE"/> <family
value="FLINTSTONE"/> <given value="FRED"/> <given value="J"/> </name> <telecom> <system value="phone"/> <value
value="314-555-1212"/> <use value="home"/> <rank value="1"/> </telecom> <gender value="male"/> <birthDate
value="1901-12-31"/> <communication> <language> <coding> <system value="ISO
639-1"/> <code
value="EN"/> <display
value="English"/> </coding> <text
value="English"/> </language> </communication> </Patient> |
Patient visits and CCDA
records are stored as Lists. The patient's PID and suffix ‘Q’ is used to
retrieve a List.
Name |
Description |
id |
Patient's PID. This is retrieved using the
search function. |
A List record is
returned on the query using the PID and suffix ‘Q’. The following table
describes the information returned.
Name |
Description |
id |
List's ID. Lists are assigned a specific
identifier that is based on the Patient’s ID. |
identifier |
Is Always “PSMD” |
entry |
An entry in the list of visits and CDA
records. Contains Extensions and Items. |
extension |
Original File name for CDA document. |
item-Reference |
Absolute Path to the CDA document on the same
server. |
item-display |
Date of the relevant visit in MMDDYYYY format. |
subject |
Patient this list is related to. |
date |
Date of visits a list links to. YYYY-MM-DD
format. |
Other resources have
date values stored directly in the resource itself and can be directly searched
for by patient and date. Dates are in a YYYY-MM-DD format.
Dates are passed as parameters on the URL.
Comparators (>, <, <=, =>) are not supported and these are passed
in as part of the date as shown below.
date=eq2018-01-01
date=gt2018-01-01
The following comparators are supported:
Comparator |
Description |
eq |
equal |
gt |
greater than |
ge |
greater than or equal |
lt |
less than |
le |
less than or equal |
The patient's PID used
to retrieve the patient, a suffix ‘B’, and an incrementing number is passed as
part of the URL to retrieve all problems.You can also search for ones
associated with the patient or a date range.
GET https://your.FHIRserver.com/Condition/patientidBincrement
GET https://your.FHIRserver.com/Condition?category=problem&onset-date=gedaterangelowerlimit&onset-date=ledaterangeupperlimit&subject=Patient/patientidA
Name |
Description |
id |
The logical ID of the problem. This is based
on the patient ID. |
onset-date |
The date the problem started. |
subject |
The patient that has the problem. |
category |
Always “problem” for patient problems. |
The patient's problems
or diagnosis are returned. The following table describes the information
returned:
Name |
Description |
id |
Condition record unique identifier. |
clinicalStatus |
Status of the problem. Valid entries include
Active, Resolved |
Code |
ID of the condition, problem, or diagnosis.
Select from SNOMED, ICD10, ICD9. |
onsetString |
Date the Problem
started. YYYY-MM-DD format. |
onsetDateTime |
Date the Problem
started. YYYY-MM-DD format. |
subject |
The patient that has the problem. |
The patient's PID used
to retrieve the patient, a suffix ‘G’, and an incrementing number is passed as
part of the URL to retrieve all immunizations. You can also search for ones
associated with the patient or a date range.
GET https://your.FHIRserver.com/Immunization/patientidGincrement
GET https://your.FHIRserver.com/Immunization?date=gedaterangelowerlimit&date=ledaterangeupperlimit&patient=Patient/patientidA
Name |
Description |
id |
The logical ID of the immunization. This is
based on the patient ID. |
date |
The date the immunization occurred. |
patient |
The patient that had the immunization. |
The patient's
immunizations are returned. The following table describes the information
returned.
Name |
Description |
id |
Immunization record unique identifier. |
status |
Immunization current status. For more
information on this value set, see medication-admin-status. |
date |
Date and time when the immunization was
administered. |
vaccineCode |
Vaccine product administered. Values come from
vaccine-code. |
lotNumber |
Vaccine lot number. |
expirationDate |
Vaccine expiration date. |
site |
Body site where the vaccine was administered. |
route |
How the vaccine entered the body. |
doseQuantity |
Amount of vaccine administered. |
patient |
The patient that had the immunization. |
The patient's PID used
to retrieve the patient, a suffix ‘J’, and an incrementing number is passed as
part of the URL to retrieve all goals. You can also search for ones associated
with the patient or a date range.
GET https://your.FHIRserver.com/Goal/patientidJincrement
GET https://your.FHIRserver.com/Goal?start-date=gedaterangelowerlimit&start-date=ledaterangeupperlimit&subject=Patient/patientidA
Name |
Description |
id |
The logical ID of the goal. This is based on
the patient ID. |
start-date |
Date that the goal was set. |
subject |
Patient that the goal is for. |
The patient's FHIR Goal
is returned. The following table describes the information returned
Name |
Description |
id |
Goal record unique
identifier. |
description |
Desired
outcome. |
status |
Indicates
if the goal has been reached. Options include: Proposed, Planned, Accepted,
Rejected, In-progress, Achieved, Sustaining, On-hold, and Cancelled. |
statusDate |
Date
the status was last set. |
startDateTime |
Date that the goal was
set. |
subject |
Patient that the goal
is for. |
The patient's PID used
to retrieve the patient, a suffix ‘I’, and an incrementing number is passed as
part of the URL to retrieve all devices. Fhir doesn’t support dates on the
device itself, to search devices by date, see the next section about devices implantation
events which link back to the device information.
GET https://your.FHIRserver.com/Device/patientidIincrement
Name |
Description |
id |
The logical ID of the device. This is based on
the patient ID. |
The patient's
implantable device is returned. The following table describes the information
returned
Name |
Description |
id |
Device
record unique identifier. |
identifier |
Unique
identifier assigned to a device. Note some barcodes affixed to a device
identify its type, not instance. For FDA mandated Unique Device Identifier
(UDI), use the Device.udi element |
udi |
FDA
mandated Unique device identifier |
type |
Device
type, SNOMED encoded. |
The patient's PID used
to retrieve the patient, a suffix ‘I’, an incrementing number, and an
additional ‘-A’ suffix is passed as part of the URL to retrieve all device
implantation events. You can also search for ones associated with the patient
or a date range.
GET https://your.FHIRserver.com/ActivityDefinition/patientidIincrement-A
GET https://your.FHIRserver.com/ActivityDefinition?date=gedaterangelowerlimit&date=ledaterangeupperlimit&topic=Patient/patientidA
Name |
Description |
id |
The logical ID of the event. This is based on
the patient ID. |
date |
Date that the device was implanted. |
topic |
Patient that the device was implanted in. |
The patient's
implantable device impantation activity is returned. The following table
describes the information returned
Name |
Description |
id |
Device
record unique identifier. |
status |
Indicates
whether the activity has been performed. |
date |
Date
the device was implanted. |
description |
Text
description of the implant procedure. |
code |
Implantation
procedure code. SNOMED or CHG. |
topic |
Patient that the
device was implanted in. |
relatedArtifact |
Device that was
implanted. |
The patient's PID used
to retrieve the patient, a suffix ‘F’, and an incrementing number is passed as
part of the URL to retrieve all procedures. You can also search for ones
associated with the patient or a date range.
GET https://your.FHIRserver.com/Procedure/patientidFincrement
GET https://your.FHIRserver.com/Procedure?date=gedaterangelowerlimit&date=ledaterangeupperlimit&patient=Patient/patientidA
Name |
Description |
id |
The logical ID of the procedure. This is based
on the patient ID. |
date |
The date the procedure was performed. |
patient |
Patient that the procedure was performed for. |
The patient's procedure is returned. The following table describes the
information returned
Name |
Description |
id |
Procedure
unique Identifier. |
status |
Status of the procedure, (In-Progress, Completed). |
code |
Identification
code for the procedure that indicates the procedure performed from SNOMED-CT,
or CHG. |
performedDateTime
|
The
procedure performed date and time |
subject |
Patient that the
procedure was performed for. |
The patient's PID used
to retrieve the patient, a suffix ‘D’, and an incrementing number is passed as
part of the URL to retrieve all allergies. You can also search for ones
associated with the patient or a date range.
GET https://your.FHIRserver.com/AllergyIntolerance/patientidDincrement
GET https://your.FHIRserver.com/AllergyIntolerance/patientidDincrement?date=gedaterangelowerlimit&date=ledaterangeupperlimit&patient=Patient/patientidA
Name |
Description |
id |
The logical ID of the allergy. This is based
on the patient ID. |
date |
The date the Allergy was recorded. |
patient |
Patient that has the allergy. |
The patient's allergy is
returned. The following table describes the information returned
Name |
Description |
id |
Allergy unique Identifier. |
assertedDate |
Date when the Allergy was recorded |
clinicalStatus |
Status
of the identified allergy or intolerance. The status code will be taken from
the AllergyIntolerance status value
set and the option include 'Active', 'Inactive' |
Code |
RxNorm
Code |
criticality |
Severity
of the reaction or the event. Option include 'Mild' / 'Moderate' or 'Severe' |
patient |
Patient that has the
allergy. |
The patient's PID used
to retrieve the patient, a suffix ‘C’, and an incrementing number is passed as
part of the URL to retrieve all medications. You can also search for ones
associated with the patient or a date range.
GET https://your.FHIRserver.com/MedicationStatement/patientidCincrement
GET https://your.FHIRserver.com/MedicationStatement/patientidCincrement?effective=gedaterangelowerlimit&effective=ledaterangeupperlimit&subject=Patient/patientidA
Name |
Description |
id |
The logical ID of the medication record. This
is based on the patient ID. |
effective |
The date the patient started on the
medication. |
subject |
The patient the medication is for. |
The patient's medication
statement is returned. The following table describes the information returned
Name |
Description |
id |
Medication unique Identifier. |
status |
Medication Status. Option include 'Active', 'Completed'. For
more information on this value set, see medication-order-status. |
medicationCodeableConcept |
Medication being administered or to be taken. For more details,
Refer to RxNorm code set. |
effectiveDateTime |
The date the patient
started on the medication. YYY-MM-DD format |
subject |
The patient the
medication is for. |
The patient's PID used
to retrieve the patient, a suffix ‘K’, and an incrementing number is passed as
part of the URL to retrieve all laboratory test orders. You can also search for
ones associated with the patient or a date range.
GET https://your.FHIRserver.com/ProcedureRequest/patientidKincrement
GET https://your.FHIRserver.com/ProcedureRequest?occurrence=gedaterangelowerlimit&occurrence=ledaterangeupperlimit&patient=Patient/patientidA
Name |
Description |
id |
The logical ID of the test. This is based on
the patient ID. |
occurrence |
Date the laboratory test was ordered. |
patient |
Patient the laboratory test was ordered for. |
The patient's Test
Script is returned. The following table describes the information returned
Name |
Description |
id |
Lab test unique Identifier. |
code |
Identifier for the type of test ordered. LOINC. |
occurrenceDateTime |
Date the laboratory
test was ordered. |
requisition |
External name for the order - is the Lab vendor order number. |
subject |
Patient the laboratory
test was ordered for. |
The patient's PID used
to retrieve the patient, a suffix ‘H’, and an incrementing number is passed as
part of the URL to retrieve all laboratory test results. You can also search
for ones associated with the patient or a date range.
GET https://your.FHIRserver.com/DiagnosticReport/patientidHincrement
GET https://your.FHIRserver.com/DiagnosticReport?date=gedaterangelowerlimit&date=ledaterangeupperlimit&patient=Patient/patientidA
Name |
Description |
id |
The logical ID of the result. This is based on
the patient ID. |
date |
Date of the laboratory test result |
patient |
Patient the laboratory test was for. |
The patient's Lab
Results is returned. The following table describes the information returned
Name |
Description |
id |
Lab result unique Identifier. |
identifier |
Unique Identifier for the observation instance. External ID - is
for the Lab vendor to send the results such that this ID matches to the
order. |
status |
Status of the result value or codes providing the status of the
observation. The option includes, 'Final' , Preliminary' , 'Cancelled' etc. |
code |
Code refers to the test that is performed. This is the element
bound to the LOINC coded elements. |
effectiveDateTime |
For
lab test, this is the date and tie this observation was made available to the
provider |
contained-Observation |
An
actual result of the laboratory test. |
-code |
Code refers to the test that was ordered. This element is bound
to the LOINC coded elements. |
-valueQuantity |
Numeric
results of the test. |
-valueCodableConcept |
Codeable
result of the test, i.e. positive, negative, etc. |
subject |
Patient the laboratory
test was for. |
The patient's PID used
to retrieve the patient, a suffix ‘E’, an incrementing number, a hyphen, and
sub id’s that increment from 1 through E in base 16 notation, is passed as part
of the URL to retrieve all patient vital signs. You can also search for ones
associated with the patient or a date range.
GET https://your.FHIRserver.com/Observation/patientidEincrement-sub-id
GET https://your.FHIRserver.com/Observation?date=gedaterangelowerlimit&date=ledaterangeupperlimit&patient=Patient/patientidA
Name |
Description |
id |
The logical ID of the vital sign. This is
based on the patient ID. |
date |
Date of the vital sign check. |
patient |
Patient the vital recording was taken from. |
The
patient's Vital signs are returned. The following table describes the information
returned
Name |
Description |
id |
Vital sign unique Identifier. |
status |
Status of the result value. |
code |
Vital Signs result type are coded responses to LOINC coded
tests. |
effectiveDateTime |
Clinically
relevant time/time-period for captured vitals signs. |
valueQuantity |
Vitals
Signs value records. The codes shall be taken from the UCUM units as defined
in http://unitsofmeasure.org |
valueQuantity-value |
The
value of the measured amount. The value includes an implicit precision in the
presentation value |
valueQuantity-unit |
A
human-readable form of the units. |
subject |
Patient the vital
recording was taken from. |
The patient's PID used
to retrieve the patient, a suffix ‘N’, and an incrementing number is passed as
part of the URL to retrieve references to all care team members. You can also
search for ones associated with the patient or a date range.
GET https://your.FHIRserver.com/CareTeam/patientidNincrement
GET https://your.FHIRserver.com/CareTeam?date=gedaterangelowerlimit&date=ledaterangeupperlimit&subject=Patient/patientidA
GET https://your.FHIRserver.com/Practitioner/referenced-practitioner-id
Name |
Description |
id |
The logical ID of the care team member. This
is based on the patient ID. |
date |
Dates that the provider was part of the
patients care team. |
subject |
Patient the provider is a care team member of. |
The
care team list is returned. The following table describes the information
returned.
Name |
Description |
id |
Practitioner unique Identifier. |
status |
Whether the provider is currently a current care team member. |
subject |
Patient the provider
is a care team member of. |
period |
Dates the provider was
a member of the patients care team. |
participant |
Contains a reference
to the detailed information about this provider. |
When
getting the referenced information, the patient's Practitioners are returned.
The following table describes the information returned.
Name |
Description |
id |
Practitioner unique Identifier. |
identifier |
NPI number of the provider. |
name |
The care providers name. |
telecom |
Practitioner contact
communication detail. This indicates the value in any kind of telecom details
field for the patient. |
address |
Portion of the
provider’s address. |
The patient's PID used
to retrieve the patient, a suffix ‘M’, and an incrementing number is passed as
part of the URL to retrieve all health concerns. You can also search for ones
associated with the patient or a date range.
GET https://your.FHIRserver.com/Condition/patientidMincrement
GET https://your.FHIRserver.com/Condition?category=additional-concern&onset-date=gedaterangelowerlimit&onset-date=ledaterangeupperlimit&subject=Patient/patientidA
Name |
Description |
|
id |
The logical ID of the health concern. This is
based on the patient ID. |
|
onset-date |
The date the concern started. |
|
subject |
The patient that has the concern. |
|
category |
Always “additional-concern” for patient health
concerns. |
|
The
patient's Health Concerns are returned. The following table describes the
information returned.
Name |
Description |
id |
Health Concern unique Identifier. |
clinicalStatus |
Status of the health concern. |
code |
The SNOMED or ICD10 code for the concern. |
onsetString |
Date the concern
started. |
onsetDateTime |
Date the concern
started. |
subject |
The patient that has
the concern. |
The patient's PID used
to retrieve the patient, a suffix ‘L’, and an incrementing number is passed as
part of the URL to retrieve all Assessment and Plans. You can also search for
ones associated with the patient or a date range.
GET https://your.FHIRserver.com/CarePlan/patientidLincrement
GET https://your.FHIRserver.com/CarePlan?date=gedaterangelowerlimit&date=ledaterangeupperlimit&patient=Patient/patientidA
Name |
Description |
id |
The logical ID of the Care Plan. This is based
on the patient ID. |
date |
Date the Plan was made. |
patient |
Patient the Plan is for. |
The
patient's Care Plans are returned. The following table describes the
information returned
Name |
Description |
id |
Assessment and Plan unique Identifier. |
status |
Status of the assessment and plan. |
period |
Date period the plan covers |
activity |
One activity in the
plan |
activity.extension |
Date this activity was
planned |
activity.category |
What type of activity
involved. Clinical Instruction, Future Appointment, etc. |
activity.code |
Specific SNOMED, CHG,
RxNorm, or LOINC for the planned activity. |
activity.ScheduledDateTime |
When the activity is
scheduled for. |
activity.dailyAmount |
Daily quantity. |
activity.quantity |
Total quantity. |
activity.description |
Text description of
activity. |
activity.goal |
Goal this activity is
in support of. |
activity.performer |
Who is scheduled to administer
activity. |
subject |
Patient the Plan is
for. |
Patient visits and CDA
records are stored as Lists. The patient's PID and suffix ‘Q’ is used to
retrieve a List of all of the patients visits and CDA records. You can also
search for ones associated with the patient or a date range by searching for
lists for that patient and date. The lists include absolute path links on the
server to the CCDA documents. See the qualifying searches by date section for
information about patient Lists.
GET https://your.FHIRserver.com/List/patientidQ
GET https://your.FHIRserver.com/List?identifier=PSMD&date=gedaterangelowerlimit&date=ledaterangeupperlimit&subject=Patient/patientidA
GET https://your.FHIRserver.com/listed-reference
Name |
Description |
id |
Binary file unique Identifier. |
identifier |
Hard coded as “PSMD” |
date |
Date of the visit the file was created for. |
subject |
Patient the document is for. |
The patient's FHIR
Document (CCDA) is returned in the content as a base 64 formatted binary file.
Copyright 2018 Data Tec, Inc.
All rights reserved.
HL7, CDA, CCD and FHIR are the registered trademarks of respective
companies/organizations.