Class ApiController
Retrieves a FHIR resource for a patient based on the filters passed.
Methods
AllergyIntolerance(String, String, String)
Returns FHIR-spec AllergyIntolerance resources in a Bundle. See US Core AllergyIntolerance
If "id" is specified in search, a single AllergyIntolerance resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | patient | Reference to the patient being requested (e.g. [system]-[patientIdentifier]). See Patient(String, String, String, String, String, String) |
| System.String | status | Parameter should be passed as "clinical-status" (active | inactive | resolved) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All AllergyIntolerance resources matching search parameters |
Examples
GET [base]/AllergyIntolerance?patient=1137192
Bulk(String)
Retrieve status of a bulk export
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | Unique Id of the export provided when initiating the request |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | JSON object containing links to retrieve exported files if export is completed. Otherwise X-Progress header and Retry-After will be populated |
CarePlan(String, String, String, String)
Returns FHIR-spec CarePlan resources in a Bundle. See US Core CarePlan
If "id" is specified in search, a single CarePlan resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | patient | Reference to the patient being requested (e.g. [system]-[patientIdentifier]). See Patient(String, String, String, String, String, String) |
| System.String | category | Type of plan |
| System.String | status | The current status of the plan (draft | active | on-hold | revoked | completed | entered-in-error | unknown) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All CarePlan resources matching search parameters |
Examples
GET [base]/CarePlan?patient=1137192&category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan
CareTeam(String, String, String)
Returns FHIR-spec CareTeam resources in a Bundle. See US Core CareTeam
If "id" is specified in search, a single CareTeam resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | patient | Reference to the patient being requested (e.g. [system]-[patientIdentifier]). See Patient(String, String, String, String, String, String) |
| System.String | status | Indicates whether the team is current , represents future intentions or is now a historical record. (proposed | active | suspended | inactive | entered-in-error) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All CareTeam resources matching search parameters |
Examples
GET [base]/CareTeam?patient=1137192&status=active
Condition(String, String, String, String, String, String)
Returns FHIR-spec Condition resources in a Bundle. See US Core Condition
If "id" is specified in search, a single Condition resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | patient | Reference to the patient being requested (e.g. [system]-[patientIdentifier]). See Patient(String, String, String, String, String, String) |
| System.String | category | Current category of the condition (problem-list-item | encounter-diagnosis | health-concern) |
| System.String | clinicalStatus | Current status of the condition (active | recurrence | relapse | inactive | remission | resolved) |
| System.String | code | Identification of the condition, problem or diagnosis |
| System.String | onset | The onset date of the condition. Parameter should be passed as "onset-date" |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All Condition resources matching search parameters |
Examples
GET [base]/Condition?patient=1137192
Device(String, String, String)
Returns FHIR-spec Device resources in a Bundle. See US Core Implantable Device
If "id" is specified in search, a single Device resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | patient | Reference to the patient being requested (e.g. [system]-[patientIdentifier]). See Patient(String, String, String, String, String, String) |
| System.String | type | The kind or type of device |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All Devices resources matching search parameters |
Examples
GET [base]/Device?patient=1137192
DiagnosticReport(String, String, String, String, String, String)
Returns FHIR-spec DiagnosticReport resources in a Bundle. See US Core DiagnosticReport for Lab,
See US Core DiagnosticReport for Note
Returns either note and lab report data.
If "id" is specified in search, a single DiagnosticReport resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | patient | Reference to the patient being requested (e.g. [system]-[patientIdentifier]). See Patient(String, String, String, String, String, String) |
| System.String | status | registered | partial | preliminary | final |
| System.String | category | The report category |
| System.String | code | LOINC code of the report |
| System.String | date | Date/Time of the report |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All DiagnosticReport resources matching search parameters |
Examples
GET [base]/DiagnosticReport?patient=1137192
GET [base]/DiagnosticReport?patient=f201&category=http://terminology.hl7.org/CodeSystem/v2-0074|LAB
GET [base]/DiagnosticReport?patient=1032702&code=http://loinc.org|24323-8
GET [base]/DiagnosticReport?patient=f201&category=http://terminology.hl7.org/CodeSystem/v2-0074|LAB&date=ge2010-01-14
Document(String, String)
Returns a patient's file.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | patientId | Reference to the patient being requested (e.g. [system]-[patientIdentifier]) |
| System.String | documentId | The unique identifier of the document |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | A viewable copy of the requested file |
DocumentReference(String, String, String, String, String)
Returns FHIR-spec DocumentReference resources in a Bundle. See US Core DocumentReference
If "id" is specified in search, a single DocumentReference resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource. If id="$docref" the TOC for the patient is returned. |
| System.String | patient | Reference to the patient being requested (e.g. [system]-[patientIdentifier]). See Patient(String, String, String, String, String, String) |
| System.String | category | Categorization of the document (always "clinical-note") |
| System.String | date | When the document reference was created |
| System.String | type | The type of document (this is often a LOINC code) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All DocumentReference resources matching search parameters |
Examples
GET [base]/DocumentReference/2169591
GET [base]/DocumentReference?_id=2169591
GET [base]/DocumentReference?patient=1137192
GET [base]/DocumentReference?patient=1235541&category=http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category|clinical-note
GET [base]/DocumentReference?patient=1235541&category=http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category|clinical-note&date=ge2019
GET [base]/DocumentReference?patient=1316024&type=http://loinc.org|18842-5
Encounter(String, String, String, String, String, String, String)
Returns FHIR-spec US-Core-Encounter resources in a Bundle. See US Core Encounter
If "id" is specified in search, a single US-Core-Encounter resource is returned rather than all matches in a Bundle.
Note that this only returns US-Core-Encounter resources, which are different from "Encounter" resources.
US-Core-Encounter resources are found only in DiagnosticReportNote and DocumentReference resources.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | patient | Reference to the patient being requested (e.g. [system]-[patientIdentifier]). See Patient(String, String, String, String, String, String) |
| System.String | identifier | A system identifier associated with a patient |
| System.String | date | The start date and time of the encounter |
| System.String | status | The current encounter status (planned | arrived | triaged | in-progress | onleave | finished | cancelled) |
| System.String | type | |
| System.String | classCode | Classification of patient encounter. Parameter should be passed as "class" |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All US-Core-Encounter resources matching search parameters |
Examples
GET [base]/Encounter/12354
GET [base]/Encounter?_id=12354
GET [base]/Encounter?patient=1137192
GET [base]/Encounter?patient=example1&date=ge2019
Goal(String, String, String)
Returns FHIR-spec Goal resources in a Bundle. See US Core Goal
If "id" is specified in search, a single Goal resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | patient | Reference to the patient being requested (e.g. [system]-[patientIdentifier]). See Patient(String, String, String, String, String, String) |
| System.String | status | The life cycle status of the goal (proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected). Parameter should be passed as "lifecycle-status" |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All Goal resources matching search parameters |
Examples
GET [base]/Goal?patient=1137192
Group(String, String)
Initiates a bulk FHIR export for the provided group and filter type
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | groupId | ChartMaker API group Id |
| System.String | type | Comma-delineated list of Resource types to be returned |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | Content-location header will contain unique Id for tracking and retrieving the export |
Immunization(String, String, String, String)
Returns FHIR-spec Immunization resources in a Bundle. See US Core Immunization
If "id" is specified in search, a single Immunization resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | patient | Reference to the patient being requested (e.g. [system]-[patientIdentifier]). See Patient(String, String, String, String, String, String) |
| System.String | status | The immunization status (completed | entered-in-error | not-done) |
| System.String | date | Vaccine administration date |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All Immunization resources matching search parameters |
Examples
GET [base]/Immunization?patient=1137192
Location(String, String, String, String, String, String)
Returns FHIR-spec Location resources in a Bundle. See US Core Location
Returns either note and lab report data.
If "id" is specified in search, a single Location resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | name | Name of the location as used by humans |
| System.String | address | Line 1 address of the Location |
| System.String | address_city | The location's city. Parameter should be passed as "address-city" |
| System.String | address_state | The location's state. Parameter should be passed as "address-state" |
| System.String | address_postalcode | The location's postal code. Parameter should be passed as "address-postalcode" |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All Location resources matching search parameters |
Examples
GET [base]/Location?name=Health
GET [base]/Location?address=Arbor
GET [base]/Location?address-city=Ann Arbor
GET [base]/Location?address-state=MI
GET [base]/Location?address-postalcode=48104
MedicationRequest(String, String, String, String, String, String)
Returns FHIR-spec MedicationRequest resources in a Bundle. See US Core Medication Request
If "id" is specified in search, a single MedicationRequest resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | patient | Reference to the patient being requested (e.g. [system]-[patientIdentifier]). See Patient(String, String, String, String, String, String) |
| System.String | intent | The kind of medication order (proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option) |
| System.String | authoredOn | Date/Time of when request was initially authored |
| System.String | encounter | Reference to an Encounter resource that the MedicationRequest belongs to. See Encounter(String, String, String, String, String, String, String) |
| System.String | status | active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All MedicationRequest resources matching search parameters |
Examples
GET [base]/MedicationRequest?patient=14676&intent=order,plan
GET [base]/MedicationRequest?patient=1137192&intent=order,plan&status=active
Observation(String, String, String, String, String, String)
Returns FHIR-spec Observation resources in a Bundle. See US Core Observation for Lab,
See US Core Pediatric BMI for Age,
See US Core pediatric head occipital frontal circumference,
See US Core Pediatric Weight for Height,
See US Core Pulse Oximetry,
See US Core Smoking Status.
If "id" is specified in search, a single Observation resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | patient | Reference to the patient being requested (e.g. [system]-[patientIdentifier]). See Patient(String, String, String, String, String, String) |
| System.String | status | The current status of the observation (registered | preliminary | final | amended) |
| System.String | category | The observation category (laboratory | vital-signs | social-history) |
| System.String | code | The LOINC code for the type observation (e.g. http://loinc.org|[code]) |
| System.String | date | The date-time the observation was taken. Modifiers gt, lt, ge, or le in front of date are accepted to get any values greater than, less than, greater than equal to, or less than equal to. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All Observation resources matching search parameters |
Examples
GET [base]/Observation?patient=1134281&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory
GET [base]/Observation?patient=1134281&code=http://loinc.org|2339-0
GET [base]/Observation?patient=1134281&code=http://loinc.org|2339-0,http://loinc.org|25428-4,2514-8
GET [base]Observation?patient=555580&category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory&date=ge2018-03-14
Organization(String, String, String)
Returns FHIR-spec Organization resources in a Bundle. See US Core Organization
If "id" is specified in search, a single Organization resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | name | The name of the organization |
| System.String | address | The first line of the organization's address |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All Organization resources matching search parameters |
Examples
GET [base]/Location?name=Health
GET [base]/Location?address=Arbor
Patient(String, String, String, String, String, String)
Returns FHIR-spec Patient resources in a Bundle. See US Core Patient
If "id" is specified in search, a single Patient resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | name | Any name for a patient (first name, last name) |
| System.String | identifier | A system identifier associated with a patient |
| System.String | birthdate | The patient's date of birth |
| System.String | family | The patient's last name |
| System.String | gender | The patient's gender |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All Patient resources matching search parameters |
Examples
GET [base]/Patient/1032702
GET [base]/Patient?_id=1032702
GET [base]/Patient?identifier=http://hospital.smarthealthit.org|1032702
GET [base]/Patient?name=Shaw
GET [base]/Patient?name=Shaw&birthdate=2007-03-20
GET [base]/Patient?name=Shaw&gender=female
Practitioner(String, String, String)
Returns FHIR-spec Practitioner resources in a Bundle. See US Core Practitioner
If "id" is specified in search, a single Patient resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The ID of the practitioner resource |
| System.String | name | Any name for a practitioner (first name, last name) |
| System.String | identifier | A system identifier associated with the practitioner |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All Practitioner resources matching search parameters |
Examples
GET [base]/Practitioner?name=Smith
GET [base]/Practitioner?identifier=http://hl7.org/fhir/sid/us-npi|97860456
Procedure(String, String, String, String, String)
Returns FHIR-spec Procedure resources in a Bundle. See US Core Procedure
If "id" is specified in search, a single Procedure resource is returned rather than all matches in a Bundle.
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
| System.String | patient | Reference to the patient being requested (e.g. [system]-[patientIdentifier]). See Patient(String, String, String, String, String, String) |
| System.String | status | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
| System.String | code | Identification of the procedure |
| System.String | date | When the procedure was performed |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | All Procedure resources matching search parameters |
Examples
GET [base]/Procedure?patient=1291938
GET [base]/Procedure?patient=1137192&date=ge2019-01-14
Provenance(String)
Returns FHIR-spec Provenance resource based on ID. See US Core Provenance
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | id | The unique ID of the resource |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | The Provenance resource matching the ID |
Examples
GET [base]/AllergyIntolerance?patient=[id]5&_revinclude=Provenance:target
GET [base]/AllergyIntolerance?_id=[id]&_revinclude=Provenance:target
Retrieve(String, String)
Retreives data gathered from a bulk export
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | requestId | Unique Id of the bulk export request |
| System.String | fileId | Unique Id of the file to retrieve |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult> | application/fhir+ndjson |
SmartStyle()
Retrieve style information to be used as part of SMART App launch
Returns
| Type | Description |
|---|---|
| Microsoft.AspNetCore.Mvc.IActionResult | SMART Style JSON object containing color and font styling |