Back to top

Patient Health Data API

API Version 1 (v1)

Documentation Updated 10/26/2020

Summary

This documentation outlines the steps that an API User must follow in order to use the Certified API Technology developed by Medical Information Technology, Inc (MEDITECH).

The Patient Health Data APIs described in detail below are based on the Argonaut Data Query Implementation Guide and are intended to meet the 2015 Edition Final Rule requirements set fourth by the Office of the National Coordinator (ONC), specifically

The MEDITECH API platform is an extension of the MEDITECH Health Care Information System (HCIS) which enables client applications to interact with MEDITECH’s databases. Each Health Care Organization will independently implement and maintain their own MEDITECH API platform, including API endpoint definitions, application access control and identity management.

API Endpoints

Please contact the Health Care Organization for more information about their API endpoints. Depending on the size and complexity of the Health Care Organization’s facility footprint, there may be multiple API endpoints.

US Core FHIR R4

As a Certified API Developer, MEDITECH is in the process of publishing a new version of the FHIR APIs which will conform to the FHIR US Core Implementation Guide. More details to come in 2021!

Terms of Use

In order to use the Patient Health Data APIs, developers must agree to the Terms of Use.

Application Registration

API Users wishing to leverage the Patient Health Data APIs must contact the Health Care Organization’s System Administrator in order to register the API User client application with the MEDITECH API platform.

This configuration involves setting up the appropriate OAuth 2.0 parameters, including

  • Client Id

  • Client Secret

  • Redirect URI

Security

Application registration allows Health Care Organization System Administrators to identify which applications are accessing the Patient Health Data APIs and limit access should an application become compromised or malfunction in order to protect the integrity of the system.

Scopes

The Patient Health Data APIs currently support the following commonly used scopes which are defined by the SMART App Launch Framework.

  • patient/*.read - Permission to read any resource for the current patient

  • user/*.* - Permission to read all resources that the current user can access

  • launch/patient - When launching outside the EHR, ask for a patient to be selected at launch time

  • openid - Permission to retrieve information about the current logged-in user

Launch Patient

The launch/patient scope will trigger the Authorization server to return a patient property in the token response that represents the Patient Resource Id which can be used to request Patient Health Data.

OpenId Connect

The openid scope is only supported when the Health Care Organization has opted to leverage a Third Party Identity Provider that supports OpenId Connect as explained in the Authentication section.

Authentication

The Authorization server requires API User authentication in conjunction with the Authorization Code grant type. API Users will be redirected to authenticate prior to the granting of an Access Token by the Authorization server.

When attempting to use the Patient Health Data APIs, if the request’s Access Token is missing, expired or invalid, a 401 Unauthorized error will be returned. The API User client application must go to the oauth/authorize endpoint to start the token process again.

The MEDITECH API Platform supports the two following Authentication mechanisms.

MEDITECH Patient Portal

API User authentication through the MEDITECH Patient Portal is ideal from a user experience perspective because the API User would be able to use their existing Patient Portal credentials. However, MEDITECH Patient Portal does not currently support OpenID Connect.

Third Party Identity Provider

API User authentication through a Third Party Identity Provider (IdP) is supported for those Health Care Organizations who don’t have MEDITECH Patient Portal or wish to use another IdP. The MEDITECH API platform will support OpenID Connect scopes (e.g. openid) when integrating with a Third Party IdP that supports OpenId Connect, such as Google Identity.

Registration

API User application developers may need to register their applications with the Identity Provider in order to leverage their services.

Credentials

When leveraging a Third Party IdP, the MEDITECH API Platform will not capture or store user credentials.

Patient Linking

The linking of an identity issued by a Third Party IdP to a patient record in the MEDITECH HCIS is a manual process that must be managed by staff member of the Health Care Organization.

Health Care Proxy

The MEDITECH API platform supports the Health Care Proxy use case. During the authentication process, the API User will be prompted to select the patient that they would like to access.

Authorization

The MEDITECH API platform’s Authorization server supports two OAuth 2.0 grant types

The intent of the API User application will dictate which grant type is appropriate and will be configured as such during Application Registration.

Access

While an API User may be granted scopes that give them access to any or all of the Patient Health Data APIs, the API User will be restricted to only resources that they are authorized to retrieve. For example, an authenticated user who is a patient will only be able to retrieve their own resources and not another patient’s resources.

General API Information

Upon completion of the Authentication/Authorization process, the API User application will be granted an Access Token that must be included within the Authorization header of subsequent Patient Health Data API requests.

Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==

The resources returned in response to Patient Health Data API requests will, at a minimum, contain the required Common Clinical Data Set elements but may also include additional information.

Search responses will consist of a Bundle resources while Read responses will simply return the requested resource.

Every API that requires a patient parameter supports the following methods, however, for documentation simplicity, only the standard method is outlined in the parameter definitions.

  • standard: patient=98fe397d-cd80-435e-9618-56143f0d0c16

  • chaining: patient.identifier=98fe397d-cd80-435e-9618-56143f0d0c16

  • search token: patient=http://[subdomain]|98fe397d-cd80-435e-9618-56143f0d0c16

All APIs that support a Read interaction also support an _id search which will return the specified resource in a Bundle.

The Patient Search APIs are disabled to clients using the launch/patient scope as the Patient Id is returned in the token response.

Server Information

The Conformance resource provides information about the resources supported by the FHIR server as well as where the security endpoints reside.

The Conformance resource is does not require an Authorization header to access.

Conformance

Conformance
GET/metadata

Example URI

GET https://[subdomain]/v1/argonaut/v1/metadata
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "url": "https://[subdomain]/v1/argonaut/v1/metadata",
  "version": "1.0.0",
  "status": "active",
  "experimental": false,
  "publisher": "Medical Information Technology, Inc",
  "contact": [
    {
      "name": "Medical Information Technology, Inc",
      "telecom": [
        {
          "system": "phone",
          "value": "781-821-3000",
          "use": "work"
        }
      ]
    }
  ],
  "rest": [
    {
      "mode": "server",
      "operation": [
        {
          "name": "$docref",
          "definition": {
            "reference": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-documentreference.html"
          }
        }
      ],
      "resource": [
        {
          "type": "AllergyIntolerance",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-allergyintolerance.html",
              "type": "token",
              "documentation": "Retrieve single AllergyIntolerance by logical id"
            },
            {
              "name": "patient",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-allergyintolerance.html",
              "type": "reference",
              "documentation": "Search for all AllergyIntolerance resources for a patient",
              "target": [
                "Patient"
              ],
              "chain": [
                "identifier"
              ]
            }
          ]
        },
        {
          "type": "CarePlan",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-careplan.html",
              "type": "token",
              "documentation": "Retrieve single CarePlan by logical id"
            },
            {
              "name": "patient",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-careplan.html",
              "type": "reference",
              "documentation": "Search for all CarePlan resources for a patient",
              "target": [
                "Patient"
              ],
              "chain": [
                "identifier"
              ]
            },
            {
              "name": "category",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-careplan.html",
              "type": "token",
              "documentation": "Search by CarePlan.category"
            },
            {
              "name": "status",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-careplan.html",
              "type": "token",
              "documentation": "Search by CarePlan.status"
            }
          ]
        },
        {
          "type": "Condition",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-condition.html",
              "type": "token",
              "documentation": "Retrieve single Condition by logical id"
            },
            {
              "name": "patient",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-condition.html",
              "type": "reference",
              "documentation": "Search for all Condition resources for a patient",
              "target": [
                "Patient"
              ],
              "chain": [
                "identifier"
              ]
            },
            {
              "name": "category",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-condition.html",
              "type": "token",
              "documentation": "Search by Condition.category"
            },
            {
              "name": "clinicalstatus",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-condition.html",
              "type": "token",
              "documentation": "Search by Condition.clinicalStatus"
            }
          ]
        },
        {
          "type": "Device",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-device.html",
              "type": "token",
              "documentation": "Retrieve single Device by logical id"
            },
            {
              "name": "patient",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-device.html",
              "type": "reference",
              "documentation": "Search for all Device resources for a patient",
              "target": [
                "Patient"
              ],
              "chain": [
                "identifier"
              ]
            }
          ]
        },
        {
          "type": "DiagnosticReport",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-diagnosticreport.html",
              "type": "token",
              "documentation": "Retrieve single DiagnosticReports by logical id"
            },
            {
              "name": "patient",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-diagnosticreport.html",
              "type": "reference",
              "documentation": "Search for all DiagnosticReports resources for a patient",
              "target": [
                "Patient"
              ],
              "chain": [
                "identifier"
              ]
            },
            {
              "name": "category",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-diagnosticreport.html",
              "type": "token",
              "documentation": "Search for all DiagnosticReports resources for a patient"
            },
            {
              "name": "code",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-diagnosticreport.html",
              "type": "token",
              "documentation": "Search by DiagnosticReport.code"
            },
            {
              "name": "date",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-diagnosticreport.html",
              "type": "date",
              "documentation": "Search by DiagnosticReport.date"
            }
          ]
        },
        {
          "type": "DocumentReference",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-documentreference.html",
              "type": "token",
              "documentation": "Retrieve single Document by logical id"
            },
            {
              "name": "patient",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-documentreference.html",
              "type": "reference",
              "documentation": "Search for all DocumentReference resources for a patient",
              "target": [
                "Patient"
              ],
              "chain": [
                "identifier"
              ]
            },
            {
              "name": "type",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-documentreference.html",
              "type": "token",
              "documentation": "Search by DocumentReference.type"
            },
            {
              "name": "period",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-documentreference.html",
              "type": "date",
              "documentation": "Search by DocumentReference.context.period"
            },
            {
              "name": "start",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-documentreference.html",
              "type": "date",
              "documentation": "Search by DocumentReference.context.period.start"
            },
            {
              "name": "end",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-documentreference.html",
              "type": "date",
              "documentation": "Search by DocumentReference.context.period.end"
            }
          ]
        },
        {
          "type": "Goal",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-goal.html",
              "type": "token",
              "documentation": "Retrieve single Goal by logical id"
            },
            {
              "name": "patient",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-goal.html",
              "type": "reference",
              "documentation": "Search for all Goal resources for a patient",
              "target": [
                "Patient"
              ],
              "chain": [
                "identifier"
              ]
            },
            {
              "name": "date",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-goal.html",
              "type": "date",
              "documentation": "Search for all Goal resources by visit date"
            }
          ]
        },
        {
          "type": "Immunization",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-immunization.html",
              "type": "token",
              "documentation": "Retrieve single Immunization by logical id"
            },
            {
              "name": "patient",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-immunization.html",
              "type": "reference",
              "documentation": "Search for all Immunization resources for a patient",
              "target": [
                "Patient"
              ],
              "chain": [
                "identifier"
              ]
            }
          ]
        },
        {
          "type": "MedicationOrder",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-medicationorder.html",
              "type": "token",
              "documentation": "Retrieve single MedicationOrder by logical id"
            },
            {
              "name": "patient",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-medicationorder.html",
              "type": "reference",
              "documentation": "Search for all MedicationOrder resources for a patient",
              "target": [
                "Patient"
              ],
              "chain": [
                "identifier"
              ]
            }
          ]
        },
        {
          "type": "MedicationStatement",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-medicationstatement.html",
              "type": "token",
              "documentation": "Retrieve single MedicationStatement by logical id"
            },
            {
              "name": "patient",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-medicationstatement.html",
              "type": "reference",
              "documentation": "Search for all MedicationStatement resources for a patient",
              "target": [
                "Patient"
              ],
              "chain": [
                "identifier"
              ]
            }
          ]
        },
        {
          "type": "Observation",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-observationresults.html",
              "type": "token",
              "documentation": "Retrieve single Observation by logical id"
            },
            {
              "name": "patient",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-observationresults.html",
              "type": "reference",
              "documentation": "Search for all Observation resources for a patient",
              "target": [
                "Patient"
              ],
              "chain": [
                "identifier"
              ]
            },
            {
              "name": "category",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-observationresults.html",
              "type": "token",
              "documentation": "Search by Observation.category"
            },
            {
              "name": "code",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-observationresults.html",
              "type": "token",
              "documentation": "Search by Observation.code"
            },
            {
              "name": "date",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-observationresults.html",
              "type": "date",
              "documentation": "Search for all Observation for a specified date of visit"
            }
          ]
        },
        {
          "type": "Patient",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-patient.html",
              "type": "token",
              "documentation": "Retrieve single patient by logical id"
            },
            {
              "name": "identifier",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-patient.html",
              "type": "token",
              "documentation": "Retrieve single patient by identifier"
            },
            {
              "name": "name",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-patient.html",
              "type": "string",
              "documentation": "Retrieve single patient by \"Last,First\" name"
            },
            {
              "name": "birthdate",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-patient.html",
              "type": "date",
              "documentation": "Retrieve single patient by birthDate"
            },
            {
              "name": "gender",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-patient.html",
              "type": "token",
              "documentation": "Retrieve single patient by gender"
            },
            {
              "name": "family",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-patient.html",
              "type": "string",
              "documentation": "Retrieve single patient by Last name"
            }
          ]
        },
        {
          "type": "Procedure",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-procedure.html",
              "type": "token",
              "documentation": "Retrieve single Procedures by logical id"
            },
            {
              "name": "patient",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-procedure.html",
              "type": "reference",
              "documentation": "Search for all Procedure resources for a patient",
              "target": [
                "Patient"
              ],
              "chain": [
                "identifier"
              ]
            },
            {
              "name": "date",
              "definition": "http://www.fhir.org/guides/argonaut/r2/StructureDefinition-argo-procedure.html",
              "type": "date",
              "documentation": "Search for all Procedures for a specified date of visit"
            }
          ]
        }
      ],
      "security": {
        "service": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/restful-security-service",
                "code": "SMART-on-FHIR"
              }
            ],
            "text": "OAuth2 using SMART-on-FHIR profile (see http://docs.smarthealthit.org)"
          }
        ],
        "extension": [
          {
            "url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris",
            "extension": [
              {
                "url": "token",
                "valueUri": "https://[subdomain]/oauth/token"
              },
              {
                "url": "authorize",
                "valueUri": "https://[subdomain]/oauth/authorize"
              }
            ]
          }
        ]
      }
    }
  ],
  "date": "2018-08-01",
  "copyright": "Copyright © 2018 Medical Information Technology, Inc.",
  "kind": "capability",
  "fhirVersion": "1.0.2",
  "acceptUnknown": "no",
  "name": "argonaut",
  "format": [
    "json"
  ],
  "description": "This profile defines the capabilities expressed by the Argonaut specification.",
  "resourceType": "Conformance"
}

Authorization Code Grant

The Authorization Code grant flow requires that the client application exchange an authorization code for an Access Token. For more information, review the OAuth 2.0 Authorization Code grant flow.

The interactions between the Authorization server, the Authentication server, client application and API User can vary depending on a Health Care Organization’s configuration.

The following provides a general definition of the OAuth APIs used when a client application is capable of protecting a client_secret.

This flow is typically implemented when the API User is a person.

Authorize

Authorize
GET/oauth/authorize{?response_type,client_id,scope,redirect_uri,state}

The client application makes an authorization request providing information agreed upon by the API User application developer and the Health Care Organization during the Application Registration process.

The client application specifies the needed Scopes.

If authentication is required, the user will be redirected to authenticate prior to being redirected back to the client application’s redirect_uri with a code.

Example URI

GET https://[subdomain]/v1/argonaut/v1/oauth/authorize?response_type=code&client_id=client@de1e0d02a84b48f9a28639b61a28b2e5&scope=patient/*.read launch/patient&redirect_uri=https:/myapp.com/redirect&state=ABC123
URI Parameters
HideShow
response_type
string (required) Example: code
client_id
string (required) Example: client@de1e0d02a84b48f9a28639b61a28b2e5
scope
string (required) Example: patient/*.read launch/patient
redirect_uri
string (required) Example: https://myapp.com/redirect
state
string (optional) Example: ABC123
Response  302
HideShow
Headers
location: https://myapp.com/redirect?code=GCI_TKobS4KcM6xBy9_pzQ%3D%3D
status: 302

Access Token

Access Token
POST/oauth/token

The authorization code is exchanged for an Access Token.

Should the client application request patient context by authorizing with the launch/patient scope, the token response will include a patient property containing Patient Resource Id.

Should the client application request an Open Id token by authorizing with the openid scope, the token response will include an openid property containing an identity token.

Example URI

POST https://[subdomain]/v1/argonaut/v1/oauth/token
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "grant_type": "authorization_code",
  "code": "GCI_TKobS4KcM6xBy9_pzQ==",
  "redirect_uri": "https://myapp.com/redirect",
  "client_id": "client@de1e0d02a84b48f9a28639b61a28b2e5",
  "client_secret": "ML-VIla8R2mgZftdEHyYzw=="
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "patient": "7891C5F5-613E-492E-8CE0-9FA9A389DB06",
  "access_token": "1OD824pfTTqZs9-y9fctLw==",
  "token_type": "bearer",
  "expires_in": 899,
  "refresh_token": "maOgmMCCRGq8ygZqzS5ZSA=="
}

Refresh Token

Refresh Token
POST/oauth/token

Should the Access Token expire, the Refresh Token can be exchanged for a new Access Token.

Example URI

POST https://[subdomain]/v1/argonaut/v1/oauth/token
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "grant_type": "refresh_token",
  "redirect_uri": "https://myapp.com/redirect",
  "client_id": "client@de1e0d02a84b48f9a28639b61a28b2e5",
  "client_secret": "ML-VIla8R2mgZftdEHyYzw==",
  "refresh_token": "PULbsKxGR36s16BXK9gGHQ=="
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "access_token": "1OD824pfTTqZs9-y9fctLw==",
  "token_type": "bearer",
  "expires_in": 899,
  "refresh_token": "dRhfJqyuQ9KWmc3StItShQ=="
}

Client Credentials Grant

The Client Credentials grant flow requires that the client application exchange the client_id and client_secret for an Access Token. For more information, review the OAuth 2.0 Client Credentials grant flow.

This flow is typically implemented when the API User is another system.

Access Token

Access Token
POST/oauth/token

The client credentials are exchanged for an Access Token.

Notice that there is no refresh_token in this scenario because the client_id and client_secret can be used to request a new Access Token at any time.

Example URI

POST https://[subdomain]/v1/argonaut/v1/oauth/token
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "grant_type": "client_credentials",
  "client_id": "client@de1e0d02a84b48f9a28639b61a28b2e5",
  "client_secret": "ML-VIla8R2mgZftdEHyYzw==",
  "scope": "patient/*.read"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "access_token": "1OD824pfTTqZs9-y9fctLw==",
  "token_type": "bearer",
  "expires_in": 899
}

Patients

The Patient resource is based on the Argonaut Patient Profile.

The following data elements will be included if available

  • Identifiers (Local, SSN) [identifier]

  • Name [name]

  • Gender [gender]

  • Date of Birth [birthDate]

  • Phone [telecom]

  • Email [telecom]

  • Address [address]

  • Marital Status [maritalStatus]

  • Race [extension]

  • Ethnicity [extension]

  • Preferred Language [communication.language]

  • Birth Sex [extension]

The value found in the id property of the Patient resource can be used as the Patient Id when making other API requests.

For example: "id": "98fe397d-cd80-435e-9618-56143f0d0c16"

Implementation

Patient searching is not often used when the API User is a patient because the patient identifier can be discovered by using the launch/patient scope during the authorization process.

Search by Identifier

Search by Identifier
GET/Patient{?identifier}

Perform a patient search by supplying the system identifier along with the patient’s identifier.

The supported system identifier searches systems include

Example URI

GET https://[subdomain]/v1/argonaut/v1/Patient?identifier=http%3A%2F%2Fhl7.org%2Ffhir%2Fsid%2Fus-ssn%7C234-65-9089
URI Parameters
HideShow
identifier
system|code (required) Example: http%3A%2F%2Fhl7.org%2Ffhir%2Fsid%2Fus-ssn%7C234-65-9089
Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
      "resource": {
        "id": "98fe397d-cd80-435e-9618-56143f0d0c16",
        "identifier": [
          {
            "system": "https://[subdomain]",
            "value": "98fe397d-cd80-435e-9618-56143f0d0c16"
          },
          {
            "system": "http://hl7.org/fhir/sid/us-ssn",
            "value": "234-65-9089"
          }
        ],
        "active": true,
        "name": [
          {
            "family": [
              "Larson"
            ],
            "given": [
              "Rebecca",
              "Jones"
            ]
          },
          {
            "family": [
              "Larson"
            ],
            "given": [
              "Robin"
            ]
          }
        ],
        "telecom": [
          {
            "value": "tel:+1(555)723-1544",
            "system": "phone",
            "use": "home"
          },
          {
            "value": "tel:+1(555)777-1234",
            "system": "other"
          },
          {
            "value": "mailto:email@email.com",
            "system": "other"
          }
        ],
        "gender": "female",
        "birthDate": "1970-05-01",
        "address": [
          {
            "use": "home",
            "line": [
              "1357 Amber Drive"
            ],
            "city": "Beaverton",
            "state": "OR",
            "postalCode": "97006",
            "country": "US"
          }
        ],
        "maritalStatus": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/marital-status",
              "code": "M",
              "display": "Married"
            }
          ],
          "text": "Married"
        },
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": "http://fhir.org/guides/argonaut/ValueSet/languages",
                  "code": "en-US",
                  "display": "English"
                }
              ],
              "text": "English"
            },
            "preferred": true
          }
        ],
        "extension": [
          {
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/v3/Ethnicity",
                  "code": "2106-3",
                  "display": "White"
                }
              },
              {
                "url": "text",
                "valueString": "White"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/argo-race"
          },
          {
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/ValueSet/v3-Ethnicity",
                  "code": "2186-5",
                  "display": "Non Hispanic or Latino"
                }
              },
              {
                "url": "text",
                "valueString": "Non Hispanic or Latino"
              }
            ],
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity"
          },
          {
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex",
            "valueCode": "F"
          }
        ],
        "resourceType": "Patient"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Patient?identifier=http%3A%2F%2Fhl7.org%2Ffhir%2Fsid%2Fus-ssn%7C234-65-9089"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Search by Name & Birth Date

Search by Name & Birth Date
GET/Patient{?name,birthdate}

Perform a patient search by supplying the patient’s name and birthdate.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Patient?name=Larson%5C%2C%20Rebecca&birthdate=1970-05-01
URI Parameters
HideShow
name
string (required) Example: Larson%5C%2C%20Rebecca

The patient’s name string in Family, Given format.

birthdate
string (required) Example: 1970-05-01

The patient’s date of birth.

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
      "resource": {
        "id": "98fe397d-cd80-435e-9618-56143f0d0c16",
        "identifier": [
          {
            "system": "https://[subdomain]",
            "value": "98fe397d-cd80-435e-9618-56143f0d0c16"
          },
          {
            "system": "http://hl7.org/fhir/sid/us-ssn",
            "value": "234-65-9089"
          }
        ],
        "active": true,
        "name": [
          {
            "family": [
              "Larson"
            ],
            "given": [
              "Rebecca",
              "Jones"
            ]
          },
          {
            "family": [
              "Larson"
            ],
            "given": [
              "Robin"
            ]
          }
        ],
        "telecom": [
          {
            "value": "tel:+1(555)723-1544",
            "system": "phone",
            "use": "home"
          },
          {
            "value": "tel:+1(555)777-1234",
            "system": "other"
          },
          {
            "value": "mailto:email@email.com",
            "system": "other"
          }
        ],
        "gender": "female",
        "birthDate": "1970-05-01",
        "address": [
          {
            "use": "home",
            "line": [
              "1357 Amber Drive"
            ],
            "city": "Beaverton",
            "state": "OR",
            "postalCode": "97006",
            "country": "US"
          }
        ],
        "maritalStatus": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/marital-status",
              "code": "M",
              "display": "Married"
            }
          ],
          "text": "Married"
        },
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": "http://fhir.org/guides/argonaut/ValueSet/languages",
                  "code": "en-US",
                  "display": "English"
                }
              ],
              "text": "English"
            },
            "preferred": true
          }
        ],
        "extension": [
          {
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/v3/Ethnicity",
                  "code": "2106-3",
                  "display": "White"
                }
              },
              {
                "url": "text",
                "valueString": "White"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/argo-race"
          },
          {
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/ValueSet/v3-Ethnicity",
                  "code": "2186-5",
                  "display": "Non Hispanic or Latino"
                }
              },
              {
                "url": "text",
                "valueString": "Non Hispanic or Latino"
              }
            ],
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity"
          },
          {
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex",
            "valueCode": "F"
          }
        ],
        "resourceType": "Patient"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Patient?name=Larson%5C%2C%20Rebecca&birthdate=1970-05-01"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Search by Name & Gender

Search by Name & Gender
GET/Patient{?name,gender}

Perform a patient search by supplying the patient’s name and gender.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Patient?name=Larson%5C%2C%20Rebecca&gender=female
URI Parameters
HideShow
name
string (required) Example: Larson%5C%2C%20Rebecca

The patient’s name string in Family, Given format.

gender
string (required) Example: female

The patient’s gender according to the Administrative Gender value set.

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
      "resource": {
        "id": "98fe397d-cd80-435e-9618-56143f0d0c16",
        "identifier": [
          {
            "system": "https://[subdomain]",
            "value": "98fe397d-cd80-435e-9618-56143f0d0c16"
          },
          {
            "system": "http://hl7.org/fhir/sid/us-ssn",
            "value": "234-65-9089"
          }
        ],
        "active": true,
        "name": [
          {
            "family": [
              "Larson"
            ],
            "given": [
              "Rebecca",
              "Jones"
            ]
          },
          {
            "family": [
              "Larson"
            ],
            "given": [
              "Robin"
            ]
          }
        ],
        "telecom": [
          {
            "value": "tel:+1(555)723-1544",
            "system": "phone",
            "use": "home"
          },
          {
            "value": "tel:+1(555)777-1234",
            "system": "other"
          },
          {
            "value": "mailto:email@email.com",
            "system": "other"
          }
        ],
        "gender": "female",
        "birthDate": "1970-05-01",
        "address": [
          {
            "use": "home",
            "line": [
              "1357 Amber Drive"
            ],
            "city": "Beaverton",
            "state": "OR",
            "postalCode": "97006",
            "country": "US"
          }
        ],
        "maritalStatus": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/marital-status",
              "code": "M",
              "display": "Married"
            }
          ],
          "text": "Married"
        },
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": "http://fhir.org/guides/argonaut/ValueSet/languages",
                  "code": "en-US",
                  "display": "English"
                }
              ],
              "text": "English"
            },
            "preferred": true
          }
        ],
        "extension": [
          {
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/v3/Ethnicity",
                  "code": "2106-3",
                  "display": "White"
                }
              },
              {
                "url": "text",
                "valueString": "White"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/argo-race"
          },
          {
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/ValueSet/v3-Ethnicity",
                  "code": "2186-5",
                  "display": "Non Hispanic or Latino"
                }
              },
              {
                "url": "text",
                "valueString": "Non Hispanic or Latino"
              }
            ],
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity"
          },
          {
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex",
            "valueCode": "F"
          }
        ],
        "resourceType": "Patient"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Patient?name=Larson%5C%2C%20Rebecca&gender=female"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Search by Family & Gender

Search by Family & Gender
GET/Patient{?family,gender}

Perform a patient search by supplying the patient’s last name and gender.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Patient?family=Larson&gender=female
URI Parameters
HideShow
family
string (required) Example: Larson

The patient’s last name.

gender
string (required) Example: female

The patient’s gender according to the Administrative Gender value set.

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
      "resource": {
        "id": "98fe397d-cd80-435e-9618-56143f0d0c16",
        "identifier": [
          {
            "system": "https://[subdomain]",
            "value": "98fe397d-cd80-435e-9618-56143f0d0c16"
          },
          {
            "system": "http://hl7.org/fhir/sid/us-ssn",
            "value": "234-65-9089"
          }
        ],
        "active": true,
        "name": [
          {
            "family": [
              "Larson"
            ],
            "given": [
              "Rebecca",
              "Jones"
            ]
          },
          {
            "family": [
              "Larson"
            ],
            "given": [
              "Robin"
            ]
          }
        ],
        "telecom": [
          {
            "value": "tel:+1(555)723-1544",
            "system": "phone",
            "use": "home"
          },
          {
            "value": "tel:+1(555)777-1234",
            "system": "other"
          },
          {
            "value": "mailto:email@email.com",
            "system": "other"
          }
        ],
        "gender": "female",
        "birthDate": "1970-05-01",
        "address": [
          {
            "use": "home",
            "line": [
              "1357 Amber Drive"
            ],
            "city": "Beaverton",
            "state": "OR",
            "postalCode": "97006",
            "country": "US"
          }
        ],
        "maritalStatus": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/marital-status",
              "code": "M",
              "display": "Married"
            }
          ],
          "text": "Married"
        },
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": "http://fhir.org/guides/argonaut/ValueSet/languages",
                  "code": "en-US",
                  "display": "English"
                }
              ],
              "text": "English"
            },
            "preferred": true
          }
        ],
        "extension": [
          {
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/v3/Ethnicity",
                  "code": "2106-3",
                  "display": "White"
                }
              },
              {
                "url": "text",
                "valueString": "White"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/argo-race"
          },
          {
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/ValueSet/v3-Ethnicity",
                  "code": "2186-5",
                  "display": "Non Hispanic or Latino"
                }
              },
              {
                "url": "text",
                "valueString": "Non Hispanic or Latino"
              }
            ],
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity"
          },
          {
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex",
            "valueCode": "F"
          }
        ],
        "resourceType": "Patient"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Patient?family=Larson&gender=female"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Search by Family & Birth Date

Search by Family & Birth Date
GET/Patient{?family,birthdate}

Perform a patient search by supplying the patient’s last name and gender.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Patient?family=Larson&birthdate=1970-05-01
URI Parameters
HideShow
family
string (required) Example: Larson

The patient’s last name.

birthdate
string (required) Example: 1970-05-01

The patient’s date of birth.

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
      "resource": {
        "id": "98fe397d-cd80-435e-9618-56143f0d0c16",
        "identifier": [
          {
            "system": "https://[subdomain]",
            "value": "98fe397d-cd80-435e-9618-56143f0d0c16"
          },
          {
            "system": "http://hl7.org/fhir/sid/us-ssn",
            "value": "234-65-9089"
          }
        ],
        "active": true,
        "name": [
          {
            "family": [
              "Larson"
            ],
            "given": [
              "Rebecca",
              "Jones"
            ]
          },
          {
            "family": [
              "Larson"
            ],
            "given": [
              "Robin"
            ]
          }
        ],
        "telecom": [
          {
            "value": "tel:+1(555)723-1544",
            "system": "phone",
            "use": "home"
          },
          {
            "value": "tel:+1(555)777-1234",
            "system": "other"
          },
          {
            "value": "mailto:email@email.com",
            "system": "other"
          }
        ],
        "gender": "female",
        "birthDate": "1970-05-01",
        "address": [
          {
            "use": "home",
            "line": [
              "1357 Amber Drive"
            ],
            "city": "Beaverton",
            "state": "OR",
            "postalCode": "97006",
            "country": "US"
          }
        ],
        "maritalStatus": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/marital-status",
              "code": "M",
              "display": "Married"
            }
          ],
          "text": "Married"
        },
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": "http://fhir.org/guides/argonaut/ValueSet/languages",
                  "code": "en-US",
                  "display": "English"
                }
              ],
              "text": "English"
            },
            "preferred": true
          }
        ],
        "extension": [
          {
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/v3/Ethnicity",
                  "code": "2106-3",
                  "display": "White"
                }
              },
              {
                "url": "text",
                "valueString": "White"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/argo-race"
          },
          {
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "http://hl7.org/fhir/ValueSet/v3-Ethnicity",
                  "code": "2186-5",
                  "display": "Non Hispanic or Latino"
                }
              },
              {
                "url": "text",
                "valueString": "Non Hispanic or Latino"
              }
            ],
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity"
          },
          {
            "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex",
            "valueCode": "F"
          }
        ],
        "resourceType": "Patient"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Patient?family=Larson&birthdate=1970-05-01"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Read

Read
GET/Patient/{id}

Retrieve a specific Patient resource by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Patient/98fe397d-cd80-435e-9618-56143f0d0c16
URI Parameters
HideShow
id
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "98fe397d-cd80-435e-9618-56143f0d0c16",
  "identifier": [
    {
      "system": "https://[subdomain]",
      "value": "98fe397d-cd80-435e-9618-56143f0d0c16"
    },
    {
      "system": "http://hl7.org/fhir/sid/us-ssn",
      "value": "234-65-9089"
    }
  ],
  "active": true,
  "name": [
    {
      "family": [
        "Larson"
      ],
      "given": [
        "Rebecca",
        "Jones"
      ]
    },
    {
      "family": [
        "Larson"
      ],
      "given": [
        "Robin"
      ]
    }
  ],
  "telecom": [
    {
      "value": "tel:+1(555)723-1544",
      "system": "phone",
      "use": "home"
    },
    {
      "value": "tel:+1(555)777-1234",
      "system": "other"
    },
    {
      "value": "mailto:email@email.com",
      "system": "other"
    }
  ],
  "gender": "female",
  "birthDate": "1970-05-01",
  "address": [
    {
      "use": "home",
      "line": [
        "1357 Amber Drive"
      ],
      "city": "Beaverton",
      "state": "OR",
      "postalCode": "97006",
      "country": "US"
    }
  ],
  "maritalStatus": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/marital-status",
        "code": "M",
        "display": "Married"
      }
    ],
    "text": "Married"
  },
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "http://fhir.org/guides/argonaut/ValueSet/languages",
            "code": "en-US",
            "display": "English"
          }
        ],
        "text": "English"
      },
      "preferred": true
    }
  ],
  "extension": [
    {
      "extension": [
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "http://hl7.org/fhir/v3/Ethnicity",
            "code": "2106-3",
            "display": "White"
          }
        },
        {
          "url": "text",
          "valueString": "White"
        }
      ],
      "url": "http://hl7.org/fhir/StructureDefinition/argo-race"
    },
    {
      "extension": [
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "http://hl7.org/fhir/ValueSet/v3-Ethnicity",
            "code": "2186-5",
            "display": "Non Hispanic or Latino"
          }
        },
        {
          "url": "text",
          "valueString": "Non Hispanic or Latino"
        }
      ],
      "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity"
    },
    {
      "url": "http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex",
      "valueCode": "F"
    }
  ],
  "resourceType": "Patient"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Medication Allergies

The AllergyIntolerance resource is based on the Argonaut AllergyIntolerance Profile.

The following data elements will be included if available

  • Patient [patient.reference]

  • Status [status]

  • Substance Code (RXNORM) [substance.coding]

  • Reaction Code (SNOMED-CT) [reaction.manifestation.coding]

  • Severity [reaction.severity]

Read

Read
GET/AllergyIntolerance/{id}

Retrieve a specific AllergyIntolerance resource by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/AllergyIntolerance/97083037-1377-470d-a290-9b92186953b2
URI Parameters
HideShow
id
string (required) Example: 97083037-1377-470d-a290-9b92186953b2

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "97083037-1377-470d-a290-9b92186953b2",
  "patient": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "reaction": [
    {
      "manifestation": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "247472004",
              "display": "Hives"
            }
          ],
          "text": "Hives"
        }
      ],
      "severity": "moderate"
    }
  ],
  "onset": "2017-03-30T00:00:00",
  "substance": {
    "coding": [
      {
        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
        "code": "733"
      }
    ],
    "text": "ampicillin"
  },
  "status": "active",
  "criticality": "CRITH",
  "type": "allergy",
  "resourceType": "AllergyIntolerance"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Problems & Health Concerns

The Condition resource is based on the Argonaut Condition Profile.

The following Problem data elements will be included if available

  • Patient [patient.reference]

  • Status [clinicalStatus]

  • Verification Status [verificationStatus]

  • Category (problem) [category.coding.code]

  • Code (SNOMED-CT) [code.coding]

The following Health Concern data elements will be included if available

  • Patient [patient.reference]

  • Status [clinicalStatus]

  • Verification Status [verificationStatus]

  • Category (health-concern) [category.coding.code]

  • Text [code.text]

Read

Read
GET/Condition/{id}

Retrieve a specific Condition resource by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Condition/1c000f07-a07d-4034-84f2-5802749bf2e9
URI Parameters
HideShow
id
string (required) Example: 1c000f07-a07d-4034-84f2-5802749bf2e9

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "1c000f07-a07d-4034-84f2-5802749bf2e9",
  "patient": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "clinicalStatus": "active",
  "verificationStatus": "confirmed",
  "category": {
    "coding": [
      {
        "system": "http://argonaut.hl7.org",
        "code": "problem",
        "display": "Problem"
      }
    ],
    "text": "Problem"
  },
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "83986005",
        "display": "Severe hypothyroidism"
      }
    ]
  },
  "resourceType": "Condition"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Home Medications

The MedicationStatement resource is based on the Argonaut MedicationStatement Profile.

The following data elements will be included if available

  • Patient [patient.reference]

  • Date [_dateAsserted]

  • Status [status]

  • Medication (RXNORM) [medicationCodeableConcept.coding]

Read

Read
GET/MedicationStatement/{id}

Retrieve a specific MedicationStatement by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/MedicationStatement/2ed75da4-32bf-419c-bdf0-20d2ebc42bb1
URI Parameters
HideShow
id
string (required) Example: 2ed75da4-32bf-419c-bdf0-20d2ebc42bb1

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "2ed75da4-32bf-419c-bdf0-20d2ebc42bb1",
  "patient": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "status": "active",
  "_dateAsserted": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
        "valueCode": "unknown"
      }
    ]
  },
  "effectivePeriod": {
    "start": "2017-03-30T13:46:00"
  },
  "medicationCodeableConcept": {
    "coding": [
      {
        "code": "309078",
        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
        "display": "Cefpodoxime Proxetil"
      }
    ]
  },
  "resourceType": "MedicationStatement"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Prescribed Medications

The MedicationOrder resource is based on the Argonaut MedicationOrder Profile.

The following data elements will be included if available

  • Patient [patient.reference]

  • Date [dateWritten]

  • Status [status]

  • Prescriber [prescriber]

  • Medication (RXNORM) [medicationCodeableConcept.coding]

Read

Read
GET/MedicationOrder/{id}

Retrieve a specific MedicationOrder resource by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/MedicationOrder/f51c74b4-1e18-401a-b701-9acd9963db6b
URI Parameters
HideShow
id
string (required) Example: f51c74b4-1e18-401a-b701-9acd9963db6b

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "f51c74b4-1e18-401a-b701-9acd9963db6b",
  "patient": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "prescriber": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
        "valueCode": "unknown"
      }
    ]
  },
  "dateWritten": "2017-03-30T13:46:00",
  "status": "active",
  "medicationCodeableConcept": {
    "coding": [
      {
        "code": "309078",
        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
        "display": "Cefpodoxime Proxetil"
      }
    ]
  },
  "resourceType": "MedicationOrder"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Immunizations

The Immunization resource is based on the Argonaut Immunization Profile.

The following data elements will be included if available

  • Patient [patient.reference]

  • Status [status]

  • Administered Date [date]

  • Vaccine Code (CVX) [vaccineCode.coding]

  • Given Indicator [wasNotGiven]

  • Reported Indicator [reported]

Read

Read
GET/Immunization/{id}

Retrieve a specific Immunization resource by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Immunization/6ef16b1c-529d-4061-b8d9-42c126752f0b
URI Parameters
HideShow
id
string (required) Example: 6ef16b1c-529d-4061-b8d9-42c126752f0b

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "6ef16b1c-529d-4061-b8d9-42c126752f0b",
  "status": "completed",
  "date": "2014-05-10T00:00:00",
  "vaccineCode": {
    "coding": [
      {
        "code": "88",
        "display": "Influenza, unspecified formulation",
        "system": "http://hl7.org/fhir/sid/cvx"
      }
    ]
  },
  "patient": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "_reported": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
        "valueCode": "unsupported"
      }
    ]
  },
  "wasNotGiven": false,
  "resourceType": "Immunization"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Smoking Status

The Observation resource is based on the Argonaut Smoking Status Profile.

The following data elements will be included if available

  • Patient [subject.reference]

  • Status [status]

  • Recorded Date/Time [issued]

  • Value code [valueCodeableConcept.coding]

  • Code (72166-2) [code.coding]

Read

Read
GET/Observation/{id}

Retrieve a specific Observation resource by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Observation/9c78d516-3dd6-49e5-a695-4a4ed922a5b7
URI Parameters
HideShow
id
string (required) Example: 9c78d516-3dd6-49e5-a695-4a4ed922a5b7

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "9c78d516-3dd6-49e5-a695-4a4ed922a5b7",
  "status": "final",
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "72166-2"
      }
    ]
  },
  "subject": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "issued": "2017-04-10T12:08:00+00:00",
  "valueCodeableConcept": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "449868002",
        "display": "Current every day smoker"
      }
    ]
  },
  "resourceType": "Observation"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Devices

The Device resource is based on the Argonaut Device Profile.

The following data elements will be included if available

  • Patient [patient.reference]

  • Type [type.text]

  • Unique Device Identifier [udi]

Read

Read
GET/Device/{id}

Retrieve a specific Device resource by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Device/676e6d6f-aeba-45c2-81bd-4af6d314492b
URI Parameters
HideShow
id
string (required) Example: 676e6d6f-aeba-45c2-81bd-4af6d314492b

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "676e6d6f-aeba-45c2-81bd-4af6d314492b",
  "patient": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "udi": "(01)00643169007222(10)704708004",
  "type": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "704707009",
        "display": "Coated femoral stem prosthesis, modular"
      }
    ]
  },
  "resourceType": "Device"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Care Plan

The CarePlan resource is based on the Argonaut CarePlan Profile.

The following data elements will be included if available

  • Patient [subject.reference]

  • Status [status]

  • Category (assess-plan) [category.coding.code]

  • Narrative [text]

Read

Read
GET/CarePlan/{id}

Retrieve a specific CarePlan resource by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/CarePlan/d02134c2-c39e-4b52-96e3-80035a71c6e6
URI Parameters
HideShow
id
string (required) Example: d02134c2-c39e-4b52-96e3-80035a71c6e6

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "d02134c2-c39e-4b52-96e3-80035a71c6e6",
  "subject": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "text": {
    "status": "generated",
    "div": "<div><b>Plan of Treatment:</b><br /><br />Schedule an appointment with Dr Seven after 1 week for follow up with Outpatient facility for <br />Immunosuppressive Therapy<br /><br /><b>Assessments:</b><br /><br />The Patient was found to have Anemia and Dr Seven and his staff diagnosed the condition and treated <br />Ms Rebecca for Anemia during the 2 day stay at Community Health Hospitals.  Ms Rebecca recovered <br />from Anemia during the stay and is being discharged in a stable condition.  If there is fever <br />greater than 101.5 F or onset of chest pain/breathlessness the patient is advised to contact <br />emergency. </div>"
  },
  "status": "active",
  "category": [
    {
      "text": "careplan",
      "coding": [
        {
          "code": "assess-plan",
          "system": "http://argonaut.hl7.org"
        }
      ]
    }
  ],
  "resourceType": "CarePlan"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Care Team

The CarePlan resource is based on the Argonaut CareTeam Profile.

The following data elements will be included if available

  • Patient [subject.reference]

  • Status [status]

  • Category (careteam) [category.coding.code]

  • Participant Role [participant.role.text]

  • Names [contained.name]

  • Telephone [contained.telecom]

  • Address [contained.address]

Read

Read
GET/CarePlan/{id}

Retrieve a specific CarePlan resource by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/CarePlan/f2ca92bb-1fe1-4009-9803-fed326209d2e
URI Parameters
HideShow
id
string (required) Example: f2ca92bb-1fe1-4009-9803-fed326209d2e

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "f2ca92bb-1fe1-4009-9803-fed326209d2e",
  "subject": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "participant": [
    {
      "role": {
        "text": "Primary Care Provider"
      },
      "member": {
        "reference": "#crs0",
        "display": "Practitioner"
      }
    }
  ],
  "contained": [
    {
      "name": {
        "family": [
          "Seven"
        ],
        "given": [
          "Henry"
        ]
      },
      "telecom": [
        {
          "value": "tel:+1(555)555-1002",
          "system": "phone",
          "use": "work"
        }
      ],
      "address": [
        {
          "line": [
            "Community Health and Hospitals",
            "1002 Healthcare Drive"
          ],
          "city": "PORTLAND",
          "state": "OR",
          "postalCode": "97266"
        }
      ],
      "id": "crs0",
      "resourceType": "Practitioner"
    }
  ],
  "status": "active",
  "category": [
    {
      "coding": [
        {
          "system": "http://argonaut.hl7.org",
          "code": "careteam"
        }
      ]
    }
  ],
  "resourceType": "CarePlan"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Vital Signs

The Observation resource is based on the Argonaut Vital Signs Observation Profile.

The following data elements will be included if available

  • Patient [subject.reference]

  • Status [status]

  • Category (vital-signs) [category.coding.code]

  • Vital Sign Code [code.coding]

  • Recorded Date [effectiveDateTime]

  • Result [valueQuantity]

Search for All

Search for All
GET/Observation{?patient,category}

Perform an Observation search by supplying the patient id and category.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Observation?patient=98fe397d-cd80-435e-9618-56143f0d0c16&category=vital-signs
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

category
string (required) Example: vital-signs

Static

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Observation/9b0daec9-1a90-4e5b-923f-8b6062943956",
      "resource": {
        "id": "9b0daec9-1a90-4e5b-923f-8b6062943956",
        "status": "final",
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "category": [
          {
            "coding": [
              {
                "code": "vital-signs",
                "display": "Vital Signs",
                "system": "http://hl7.org/fhir/observation-category"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "effectiveDateTime": "2017-05-30T13:57:00",
        "code": {
          "coding": [
            {
              "code": "8302-2",
              "display": "Body height",
              "system": "http://loinc.org"
            }
          ]
        },
        "valueQuantity": {
          "value": 177,
          "unit": "cm",
          "code": "cm",
          "system": "http://unitsofmeasure.org"
        },
        "resourceType": "Observation"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Observation?patient=98fe397d-cd80-435e-9618-56143f0d0c16"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Search by Code

Search by Code
GET/Observation{?patient,code}

Perform an Observation search by supplying the patient id and code.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Observation?patient=98fe397d-cd80-435e-9618-56143f0d0c16&code=8302-2
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

code
string (required) Example: 8302-2

LOINC Code

  • 9279-1 Respiratory Rate

  • 8867-4 Heart Rate

  • 59408-5 Oxygen Saturation

  • 8310-5 Body Temperature

  • 8302-2 Body Height

  • 29463-7 Body Weight

  • 39156-5 Body Mass Index

  • 8480-6 Systolic Blood Pressure

  • 8462-4 Diastolic Blood Pressure

  • 55284-4 Blood Pressure Systolic and Diastolic

  • 3150-0 Inhaled Oxygen Concentration

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Observation/9b0daec9-1a90-4e5b-923f-8b6062943956",
      "resource": {
        "id": "9b0daec9-1a90-4e5b-923f-8b6062943956",
        "status": "final",
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "category": [
          {
            "coding": [
              {
                "code": "vital-signs",
                "display": "Vital Signs",
                "system": "http://hl7.org/fhir/observation-category"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "effectiveDateTime": "2017-05-30T13:57:00",
        "code": {
          "coding": [
            {
              "code": "8302-2",
              "display": "Body height",
              "system": "http://loinc.org"
            }
          ]
        },
        "valueQuantity": {
          "value": 177,
          "unit": "cm",
          "code": "cm",
          "system": "http://unitsofmeasure.org"
        },
        "resourceType": "Observation"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Observation?patient=98fe397d-cd80-435e-9618-56143f0d0c16&code=http://loinc.org%7C8302-2"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Search by Date

Search by Date
GET/Observation{?patient,category,date}

Perform an Observation search by supplying the patient id, category and date.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Observation?patient=98fe397d-cd80-435e-9618-56143f0d0c16&category=vital-signs&date=2017-05-30
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

category
string (required) Example: vital-signs

Static

date
date (required) Example: 2017-05-30
Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Observation/9b0daec9-1a90-4e5b-923f-8b6062943956",
      "resource": {
        "id": "9b0daec9-1a90-4e5b-923f-8b6062943956",
        "status": "final",
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "category": [
          {
            "coding": [
              {
                "code": "vital-signs",
                "display": "Vital Signs",
                "system": "http://hl7.org/fhir/observation-category"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "effectiveDateTime": "2017-05-30T13:57:00",
        "code": {
          "coding": [
            {
              "code": "8302-2",
              "display": "Body height",
              "system": "http://loinc.org"
            }
          ]
        },
        "valueQuantity": {
          "value": 177,
          "unit": "cm",
          "code": "cm",
          "system": "http://unitsofmeasure.org"
        },
        "resourceType": "Observation"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Observation?patient=98fe397d-cd80-435e-9618-56143f0d0c16&date=eq2017-05-30"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Read

Read
GET/Observation/{id}

Retrieve a specific Observation resource by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Observation/9b0daec9-1a90-4e5b-923f-8b6062943956
URI Parameters
HideShow
id
string (required) Example: 9b0daec9-1a90-4e5b-923f-8b6062943956

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "9b0daec9-1a90-4e5b-923f-8b6062943956",
  "status": "final",
  "subject": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "category": [
    {
      "coding": [
        {
          "code": "vital-signs",
          "display": "Vital Signs",
          "system": "http://hl7.org/fhir/observation-category"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "effectiveDateTime": "2017-05-30T13:57:00",
  "code": {
    "coding": [
      {
        "code": "8302-2",
        "display": "Body height",
        "system": "http://loinc.org"
      }
    ]
  },
  "valueQuantity": {
    "value": 177,
    "unit": "cm",
    "code": "cm",
    "system": "http://unitsofmeasure.org"
  },
  "resourceType": "Observation"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Procedures

The Procedure resource is based on the Argonaut Procedure Profile.

The following data elements will be included if available

  • Patient [subject.reference]

  • Status [status]

  • Code (SNOMED-CT) [code.coding]

  • Performed Date [performedDateTime]

Search for All

Search for All
GET/Procedure{?patient}

Perform Procedure search by supplying the patient id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Procedure?patient=98fe397d-cd80-435e-9618-56143f0d0c16
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Procedure/1dd722be-d28d-4015-843d-764e9dc43760",
      "resource": {
        "id": "1dd722be-d28d-4015-843d-764e9dc43760",
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "status": "completed",
        "performedDateTime": "2017-03-30T00:00:00",
        "code": {
          "coding": [
            {
              "code": "168731009",
              "display": "Chest X-Ray",
              "system": "http://snomed.info/sct"
            }
          ]
        },
        "resourceType": "Procedure"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Procedure?patient=98fe397d-cd80-435e-9618-56143f0d0c16"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Search by Date

Search by Date
GET/Procedure{?patient,date}

Perform a Procedure search by supplying the patient id and date.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Procedure?patient=98fe397d-cd80-435e-9618-56143f0d0c16&date=2017-03-30
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

date
date (required) Example: 2017-03-30
Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Procedure/1dd722be-d28d-4015-843d-764e9dc43760",
      "resource": {
        "id": "1dd722be-d28d-4015-843d-764e9dc43760",
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "status": "completed",
        "performedDateTime": "2017-03-30T00:00:00",
        "code": {
          "coding": [
            {
              "code": "168731009",
              "display": "Chest X-Ray",
              "system": "http://snomed.info/sct"
            }
          ]
        },
        "resourceType": "Procedure"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Procedure?patient=98fe397d-cd80-435e-9618-56143f0d0c16&date=eq2017-03-30"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Read

Read
GET/Procedure/{id}

Retrieve a specific Procedure by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Procedure/1dd722be-d28d-4015-843d-764e9dc43760
URI Parameters
HideShow
id
string (required) Example: 1dd722be-d28d-4015-843d-764e9dc43760

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "1dd722be-d28d-4015-843d-764e9dc43760",
  "subject": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "status": "completed",
  "performedDateTime": "2017-03-30T00:00:00",
  "code": {
    "coding": [
      {
        "code": "168731009",
        "display": "Chest X-Ray",
        "system": "http://snomed.info/sct"
      }
    ]
  },
  "resourceType": "Procedure"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Goals

The Goal resource is based on the Argonaut Goal Profile.

The following data elements will be included if available

  • Patient [subject.reference]

  • Status [status]

  • Text [description]

Search for All

Search for All
GET/Goal{?patient}

Perform a Goal search by supplying the patient id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Goal?patient=98fe397d-cd80-435e-9618-56143f0d0c16
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Goal/8a9e1662-3a60-4b2a-b8cf-410173a4116c",
      "resource": {
        "id": "8a9e1662-3a60-4b2a-b8cf-410173a4116c",
        "status": "proposed",
        "description": "a. Need to gain more energy to do regular activities. \r\n b Negotiated Goals to keep Body temperature at 98-99 degrees Fahrenheit with regular monitoring. ",
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "resourceType": "Goal"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Goal?patient=98fe397d-cd80-435e-9618-56143f0d0c16"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Search by Date

Search by Date
GET/Goal{?patient,date}

Perform a Goal search by supplying the patient id and date.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Goal?patient=98fe397d-cd80-435e-9618-56143f0d0c16&date=2017-06-01
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

date
date (required) Example: 2017-06-01
Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Goal/8a9e1662-3a60-4b2a-b8cf-410173a4116c",
      "resource": {
        "id": "8a9e1662-3a60-4b2a-b8cf-410173a4116c",
        "status": "proposed",
        "description": "a. Need to gain more energy to do regular activities. \r\n b Negotiated Goals to keep Body temperature at 98-99 degrees Fahrenheit with regular monitoring. ",
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "resourceType": "Goal"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Goal?patient=98fe397d-cd80-435e-9618-56143f0d0c16&date=gt2015&date=lt2016"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Read

Read
GET/Goal/{id}

Retrieve a specific Goal by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Goal/8a9e1662-3a60-4b2a-b8cf-410173a4116c
URI Parameters
HideShow
id
string (required) Example: 8a9e1662-3a60-4b2a-b8cf-410173a4116c

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "8a9e1662-3a60-4b2a-b8cf-410173a4116c",
  "status": "proposed",
  "description": "a. Need to gain more energy to do regular activities. \r\n b Negotiated Goals to keep Body temperature at 98-99 degrees Fahrenheit with regular monitoring. ",
  "subject": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "resourceType": "Goal"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Lab Tests

The DiagnosticReport resource is based on the Argonaut DiagnosticReport Profile.

The following Lab Test data elements will be included if available

  • Patient [subject.reference]

  • Status [status]

  • Test Code (LOINC) [code.coding]

  • Measured Time [effectiveDateTime]

  • Category (LAB) [category.coding.code]

  • Reported Date/Time [issued]

  • Result [result.reference]

Search for All

Search for All
GET/DiagnosticReport{?patient,category}

Perform DiagnosticReport search by supplying the patient id and category.

Example URI

GET https://[subdomain]/v1/argonaut/v1/DiagnosticReport?patient=98fe397d-cd80-435e-9618-56143f0d0c16&category=LAB
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

category
string (required) Example: LAB

Static

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/DiagnosticReport/0c342e49-93c9-4cae-8c2c-74665aa23fc6",
      "resource": {
        "id": "0c342e49-93c9-4cae-8c2c-74665aa23fc6",
        "status": "final",
        "category": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/DiagnosticReport-category",
              "code": "LAB"
            }
          ]
        },
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "5803-2",
              "display": "Urine pH measurement by dipstick"
            }
          ],
          "text": "Urine pH"
        },
        "result": [
          {
            "reference": "Observation/0c342e49-93c9-4cae-8c2c-74665aa23fc6",
            "display": "0c342e49-93c9-4cae-8c2c-74665aa23fc6"
          }
        ],
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "performer": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
              "valueCode": "unsupported"
            }
          ]
        },
        "effectiveDateTime": "2017-03-30T13:57:00",
        "_issued": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
              "valueCode": "unsupported"
            }
          ]
        },
        "resourceType": "DiagnosticReport"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/DiagnosticReport?patient=98fe397d-cd80-435e-9618-56143f0d0c16"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Search by Code

Search by Code
GET/DiagnosticReport{?patient,code}

Perform a DiagnosticReport search by supplying the patient id and code.

Example URI

GET https://[subdomain]/v1/argonaut/v1/DiagnosticReport?patient=98fe397d-cd80-435e-9618-56143f0d0c16&code=5797-6
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

code
string (required) Example: 5797-6

LOINC Code

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/DiagnosticReport/0c342e49-93c9-4cae-8c2c-74665aa23fc6",
      "resource": {
        "id": "0c342e49-93c9-4cae-8c2c-74665aa23fc6",
        "status": "final",
        "category": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/DiagnosticReport-category",
              "code": "LAB"
            }
          ]
        },
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "5797-6",
              "display": "NIST.UKET"
            }
          ],
          "text": "Urine Ketones"
        },
        "result": [
          {
            "reference": "Observation/4f0c1be9-e57e-4ca2-a96b-dbd5b76dbd90",
            "display": "4f0c1be9-e57e-4ca2-a96b-dbd5b76dbd90"
          }
        ],
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "performer": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
              "valueCode": "unsupported"
            }
          ]
        },
        "effectiveDateTime": "2017-03-30T13:57:00",
        "_issued": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
              "valueCode": "unsupported"
            }
          ]
        },
        "resourceType": "DiagnosticReport"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/DiagnosticReport?patient=98fe397d-cd80-435e-9618-56143f0d0c16&code=http://loinc.org%7C5797-6"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Search by Date

Search by Date
GET/DiagnosticReport{?patient,category,date}

Perform a DiagnosticReport search by supplying the patient id, category and date.

Example URI

GET https://[subdomain]/v1/argonaut/v1/DiagnosticReport?patient=98fe397d-cd80-435e-9618-56143f0d0c16&category=LAB&date=2017-03-30
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

category
string (required) Example: LAB

Static

date
date (required) Example: 2017-03-30
Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/DiagnosticReport/0c342e49-93c9-4cae-8c2c-74665aa23fc6",
      "resource": {
        "id": "0c342e49-93c9-4cae-8c2c-74665aa23fc6",
        "status": "final",
        "category": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/DiagnosticReport-category",
              "code": "LAB"
            }
          ]
        },
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "5803-2",
              "display": "Urine pH measurement by dipstick"
            }
          ],
          "text": "Urine pH"
        },
        "result": [
          {
            "reference": "Observation/0c342e49-93c9-4cae-8c2c-74665aa23fc6",
            "display": "0c342e49-93c9-4cae-8c2c-74665aa23fc6"
          }
        ],
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "performer": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
              "valueCode": "unsupported"
            }
          ]
        },
        "effectiveDateTime": "2017-03-30T13:57:00",
        "_issued": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
              "valueCode": "unsupported"
            }
          ]
        },
        "resourceType": "DiagnosticReport"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/DiagnosticReport?patient=98fe397d-cd80-435e-9618-56143f0d0c16&date=eq2017-03-30"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Read

Read
GET/DiagnosticReport/{id}

Retrieve a specific DiagnosticReport resource by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/DiagnosticReport/0c342e49-93c9-4cae-8c2c-74665aa23fc6
URI Parameters
HideShow
id
string (required) Example: 0c342e49-93c9-4cae-8c2c-74665aa23fc6

Resource Id

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "0c342e49-93c9-4cae-8c2c-74665aa23fc6",
  "status": "final",
  "category": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/DiagnosticReport-category",
        "code": "LAB"
      }
    ]
  },
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "5803-2",
        "display": "Urine pH measurement by dipstick"
      }
    ],
    "text": "Urine pH"
  },
  "result": [
    {
      "reference": "Observation/0c342e49-93c9-4cae-8c2c-74665aa23fc6",
      "display": "0c342e49-93c9-4cae-8c2c-74665aa23fc6"
    }
  ],
  "subject": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "performer": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
        "valueCode": "unsupported"
      }
    ]
  },
  "effectiveDateTime": "2017-03-30T13:57:00",
  "_issued": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
        "valueCode": "unsupported"
      }
    ]
  },
  "resourceType": "DiagnosticReport"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Lab Results

The Observation resource is based on the Argonaut Observation Results Profile.

The following data elements will be included if available

  • Patient [subject.reference]

  • Status [status]

  • Result Code (LOINC) [code.coding]

  • Result Value [valueString or valueQuantity]

  • Reference Range [referenceRange.text]

  • Result Time [effectiveDateTime]

  • Category (laboratory) [category.coding.code]

Search for All

Search for All
GET/Observation{?patient,category}

Perform an Observation search by supplying the patient id and category.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Observation?patient=98fe397d-cd80-435e-9618-56143f0d0c16&category=laboratory
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

category
string (required) Example: laboratory

Static

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Observation/0205ef11-4739-4a23-8747-888f8a069a00",
      "resource": {
        "id": "0205ef11-4739-4a23-8747-888f8a069a00",
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/observation-category",
                "code": "laboratory"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "5803-2",
              "display": "Urine pH measurement by dipstick"
            }
          ]
        },
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "referenceRange": [
          {
            "text": "5.0-8.0"
          }
        ],
        "effectiveDateTime": "2017-03-30T13:57:00",
        "valueString": "5.0 [pH]",
        "resourceType": "Observation"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Observation?patient=98fe397d-cd80-435e-9618-56143f0d0c16"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Search by Code

Search by Code
GET/Observation{?patient,code}

Perform an Observation search by supplying the patient id and result code.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Observation?patient=98fe397d-cd80-435e-9618-56143f0d0c16&code=5803-2
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

code
string (required) Example: 5803-2

LOINC Code

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Observation/0205ef11-4739-4a23-8747-888f8a069a00",
      "resource": {
        "id": "0205ef11-4739-4a23-8747-888f8a069a00",
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/observation-category",
                "code": "laboratory"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "5803-2",
              "display": "Urine pH measurement by dipstick"
            }
          ]
        },
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "referenceRange": [
          {
            "text": "5.0-8.0"
          }
        ],
        "effectiveDateTime": "2017-03-30T13:57:00",
        "valueString": "5.0 [pH]",
        "resourceType": "Observation"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Observation?patient=98fe397d-cd80-435e-9618-56143f0d0c16&code=http://loinc.org%7C5803-2"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Search by Date

Search by Date
GET/Observation{?patient,category,date}

Perform a patient Lab Result search by providing the patient id and date.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Observation?patient=98fe397d-cd80-435e-9618-56143f0d0c16&category=laboratory&date=2017-03-30
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

category
string (required) Example: laboratory

Static

date
date (required) Example: 2017-03-30
Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/Observation/0205ef11-4739-4a23-8747-888f8a069a00",
      "resource": {
        "id": "0205ef11-4739-4a23-8747-888f8a069a00",
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/observation-category",
                "code": "laboratory"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "5803-2",
              "display": "Urine pH measurement by dipstick"
            }
          ]
        },
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "referenceRange": [
          {
            "text": "5.0-8.0"
          }
        ],
        "effectiveDateTime": "2017-03-30T13:57:00",
        "valueString": "5.0 [pH]",
        "resourceType": "Observation"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/Observation?patient=98fe397d-cd80-435e-9618-56143f0d0c16&category=laboratory&date=eq2017-03-30"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Read

Read
GET/Observation/{id}

Retrieve a specific Observation resource by supplying the resource id.

Example URI

GET https://[subdomain]/v1/argonaut/v1/Observation/0205ef11-4739-4a23-8747-888f8a069a00
URI Parameters
HideShow
id
string (required) Example: 0205ef11-4739-4a23-8747-888f8a069a00

Resource Id

Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "id": "0205ef11-4739-4a23-8747-888f8a069a00",
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/observation-category",
          "code": "laboratory"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "5803-2",
        "display": "Urine pH measurement by dipstick"
      }
    ]
  },
  "subject": {
    "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
    "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
  },
  "referenceRange": [
    {
      "text": "5.0-8.0"
    }
  ],
  "effectiveDateTime": "2017-03-30T13:57:00",
  "valueString": "5.0 [pH]",
  "resourceType": "Observation"
}
Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Documents

The DocumentReference resource is based the Argonaut DocumentReference Profile.

The following data elements will be included if available

  • Patient [subject.reference]

  • Document URL [content.attachment.url]

  • Format [context.format]

  • Data Time Frame [context.period]

  • Type [type.coding]

  • Status [status]

  • Indexed [indexed]

  • Document Content Type [content.attachment.contentType]

Search by Type

Search by Type
GET/DocumentReference{?patient,period,type}

Perform a DocumentReference search by supplying the patient id and optional period and/or document type.

When searching for Patient documents, the Patient Resource can be included in the bundle by supplying the _include=DocumentReference:subject parameter.

The author information can be included as a contained Organization resource in the bundle by supplying the _include=DocumentReference:author parameter.

The following prefixes are supported for the period query parameter

  • eq (Equals)

  • ne (Not Equals)

  • ge (Greater than or Equals)

  • gt (Greater than)

  • le (Lesser than or Equals)

  • lt (Lesser than)

All unsupported prefixes are ignored during the search.

Range searches are performed on both the context.period.start and context.period.end values for the DocumentReference.

If either context.period properties meet the search criteria a DocumentReference resource is returned.

For example, with a context.period.start = 2017-05-01 and context.period.end = 2017-09-01

A query of period=ge2017-04&period=le2017-08, would return the resource as the start property is within range.

A query of period=eq2017-09, would return the resource as the end property is within range.

The supported document type LOINC codes are supported for the type query parameter

  • 34133-9 - Summary of episode note

  • 18842-5 - Discharge Summary

  • 57133-1 - Referral Note

Example URI

GET https://[subdomain]/v1/argonaut/v1/DocumentReference?patient=98fe397d-cd80-435e-9618-56143f0d0c16&period=le2017-08&type=34133-9
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

_include
string (optional) 

Choices: DocumentReference:author DocumentReference:subject

period
string (optional) Example: le2017-08

End Date

type
string (optional) Example: 34133-9

LOINC Code

Request
HideShow
Headers
Authorization: Bearer 1OD824pfTTqZs9-y9fctLw==
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/DocumentReference/8e7b6fd6-79dc-49a0-f98f-24852a9df3da",
      "resource": {
        "id": "8e7b6fd6-79dc-49a0-f98f-24852a9df3da",
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "content": [
          {
            "attachment": {
              "contentType": "application/xml",
              "url": "https://[subdomain]/v1/ccda-documents/9e7699e6-4cd4-4e21-5bbb-05f0d6ca648f?patient=98fe397d-cd80-435e-9618-56143f0d0c16"
            },
            "format": [
              {
                "system": "urn:oid:1.3.6.1.4.1.19376.1.2.3",
                "code": "urn:hl7-org:sdwg:ccda-structuredBody:1.1",
                "display": "For documents following C-CDA constraints using a structured body",
                "userSelected": false
              }
            ]
          }
        ],
        "context": {
          "period": {
            "start": "2015-06-22T00:00:00",
            "end": "2017-08-18T00:00:00"
          }
        },
        "contained": [
          {
            "active": true,
            "address": [
              {
                "use": "work",
                "line": [
                  "MTGH Auth street one",
                  "MTGH Auth street two"
                ],
                "city": "mtgh Auth city",
                "state": "Auth MTGH State",
                "postalCode": "02365",
                "country": "US"
              }
            ],
            "telecom": [
              {
                "value": "tel:+1(123)456-7897",
                "system": "phone",
                "use": "work"
              }
            ],
            "name": "MTGH Auth FACILITY",
            "id": "crs0",
            "resourceType": "Organization"
          }
        ],
        "author": [
          {
            "reference": "#crs0",
            "display": "facility"
          }
        ],
        "type": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "34133-9",
              "display": "Summary of episode note"
            }
          ],
          "text": "Summary of episode note"
        },
        "_indexed": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
              "valueCode": "unknown"
            }
          ]
        },
        "status": "current",
        "resourceType": "DocumentReference"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/DocumentReference?patient=98fe397d-cd80-435e-9618-56143f0d0c16"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}

Search by Date

Search by Date
GET/DocumentReference/$docref{?patient,start,end}

Perform a DocumentReference search by supplying the patient id and optional start/end date.

The following prefixes are supported for the start query parameter

  • ge (Greater than or Equals)

  • gt (Greater than)

The following prefixes are supported for the end query parameter

  • le (Less than or Equals)

  • lt (Less than)

All unsupported prefixes are ignored during the search.

The start query parameter only compared against the context.period.start property, and the end query parameter is only compared against the context.period.end property. Both context.period properties need meet the search criteria for a DocumentReference resource is returned.

For example, with a context.period.start = 2017-05-01 and context.period.end = 2017-09-01

A query of start=ge2017-04&end=le2017-08, would return the resource as the start property is within range.

A query of start=gt2017-06&end=le2017-09, would return the resource as the end property is within range.

A query of end=le2017-10, would return the resource as the end property is within range.

If no date range parameters are provided, the most recent document is returned.

Example URI

GET https://[subdomain]/v1/argonaut/v1/DocumentReference/$docref?patient=98fe397d-cd80-435e-9618-56143f0d0c16&start=ge2015-07-01&end=le2017-08-20
URI Parameters
HideShow
patient
string (required) Example: 98fe397d-cd80-435e-9618-56143f0d0c16

Patient Resource Id

start
string (optional) Example: ge2015-07-01

Start Date

end
string (optional) Example: le2017-08-20

End Date

Request
HideShow
Headers
Authorization: Basic ABC123
Response  200
HideShow
Headers
Content-Type: application/json+fhir
Body
{
  "type": "searchset",
  "entry": [
    {
      "fullUrl": "https://[subdomain]/v1/argonaut/v1/DocumentReference/8e7b6fd6-79dc-49a0-f98f-24852a9df3da",
      "resource": {
        "id": "8e7b6fd6-79dc-49a0-f98f-24852a9df3da",
        "subject": {
          "reference": "Patient/98fe397d-cd80-435e-9618-56143f0d0c16",
          "display": "98fe397d-cd80-435e-9618-56143f0d0c16"
        },
        "content": [
          {
            "attachment": {
              "contentType": "application/xml",
              "url": "https://[subdomain]/v1/ccda-documents/8e7b6fd6-79dc-49a0-f98f-24852a9df3da?patient=98fe397d-cd80-435e-9618-56143f0d0c16"
            },
            "format": [
              {
                "system": "urn:oid:1.3.6.1.4.1.19376.1.2.3",
                "code": "urn:hl7-org:sdwg:ccda-structuredBody:1.1",
                "display": "For documents following C-CDA constraints using a structured body",
                "userSelected": false
              }
            ]
          }
        ],
        "context": {
          "period": {
            "start": "2015-06-22T00:00:00",
            "end": "2017-08-18T00:00:00"
          }
        },
        "type": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "34133-9",
              "display": "Summary of episode note"
            }
          ],
          "text": "Summary of episode note"
        },
        "_indexed": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
              "valueCode": "unknown"
            }
          ]
        },
        "status": "current",
        "resourceType": "DocumentReference"
      },
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://[subdomain]/v1/argonaut/v1/DocumentReference/$docref?patient=98fe397d-cd80-435e-9618-56143f0d0c16&type=http://loinc.org%7C48764-5&start=ge2015-07-01&end=lt2017-08-20"
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Unauthorized"
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "token with scopes [scope] does not have access to the requested API"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "No Resource Data Found"
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "resource": "v1/resource/error/_version/1/",
  "detail": "Internal Server Error"
}