Compulink FHIR API Documentation - US Core 6.1.0 / USCDI v3

1. Introduction
2. Registration & Authentication
3. API Details
4. Usage Terms

1. Introduction

This guide is written for third party developers, including patients, who are developing software applications for accessing Protected Health Information (PHI) based on this public API documentation which allows applications to query secured health information.

US Core 6.1.0 / USCDI v3 Compliance

This API implementation is certified to support US Core Implementation Guide version 6.1.0 and USCDI v3 data elements. It has been tested against FHIR Inferno validation suites to ensure full conformance with ONC Health IT Certification requirements.

Applications wishing to publish such a public-facing API should have their Health IT vendor register as a developer integrator of services at https://www.compulinkadvantage.com/apipartner/.

2. Registration & Authentication

a. Application Access Requests

The API is a read-only RESTful HL7 FHIR® R4 API and follows the syntax described at https://hl7.org/fhir/R4/http.html.

All RESTful data access requests will be in the following format, in which the [base] URL will need to be obtained from the Data Holder, either directly or via directory information:

GET [base]/[resource-specific parameters]

FHIR Bulk Data Access Group export is also supported as described in the Bulk Data Access IG.

b. Connecting to the Server

The server is accessed by clients through an HTTPS connection.

Important Security Requirement

Only TLS 1.2 or higher connections are accepted. All plaintext connections will be refused.

c. Authentication - Registering an Application

Prior to making API requests, the client application must obtain an Access Token from the Compulink FHIR Registration Server. The client software must support OAuth 2.0 authorization code grant. For authorization code flow, a client ID and client secret are required.

If the client application does not have a client ID and client secret for this purpose, the client application may obtain a client ID and client secret by contacting the data owner or by completing the manual registration process at https://www.compulinkadvantage.com/apipartner/.

When an end user is directed to the authorization endpoint, the user will be presented with a login screen where they can enter their credentials. If the correct credentials are supplied and the end user grants access to the client application, an authorization code will be returned to the client that the client application can use to obtain an access token through the token endpoint as described in RFC 6749.

Each healthcare organization has a unique base URL that is used to access its Authorization Server. The required endpoint URLs are of the following form:

Endpoint	URL
Base	https://fhir.compulinkadvantage.com/[client_unique]/
Authorization	https://fhir.compulinkadvantage.com/[client_unique]/authorize
Token	https://oauth.compulinkadvantage.com/token

d. Authentication - Refresh Token

Client apps that use the authorization code flow and can securely store refresh tokens may request a refresh token by including the offline_access scope in the initial authorization endpoint request. Note that the end user may remove this scope during the authorization process.

If a refresh token is permitted, it will be returned together with the access token as per RFC 6749, and can be exchanged for a new access token as per RFC 6749. Refresh token lifetime defaults to 90 days (but may be longer or shorter depending on the Data Holder's institutional policies).

e. Authentication - Additional Users/Patient

Once an application is registered the data owner will have the ability to use the Compulink Advantage software to add or remove users and control scopes for each user.

f. Revoking Authentication

Once an application is registered the data owner will have the ability to use the Compulink Advantage software to revoke access to an application or user.

3. API Details

a. FHIR Resources by USCDI v3 Domain

Resources are organized by USCDI v3 data class domains and conform to US Core 6.1.0 profiles for ONC (g)(10) certification.

Quick Reference: Resource Coverage

USCDI v3 Required Resources: Patient, AllergyIntolerance, CarePlan, CareTeam, Condition (Problems & Health Concerns), Condition (Encounter Diagnosis), Coverage, Device, DiagnosticReport, DocumentReference, Encounter, Goal, Immunization, Location, MedicationRequest, Observation (Laboratory, Vital Signs, Smoking Status, Clinical Result, Screening Assessment), Procedure, Provenance, RelatedPerson, ServiceRequest, Specimen

Supporting Resources: Practitioner, PractitionerRole, Organization

USCDI v3 Domain: Patient Demographics

Allergies and Intolerances - US Core AllergyIntolerance Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? AllergyIntolerance resource

Supported Elements:

Resource Data Element	Data Type
AllergyIntolerance.clinicalStatus	STRING
AllergyIntolerance.verificationStatus	STRING
AllergyIntolerance.code	RxNorm, SNOMED CT
AllergyIntolerance.patient	REFERENCE
AllergyIntolerance.reaction	-
AllergyIntolerance.reaction.manifestation	STRING, SNOMED CT
AllergyIntolerance.recordedDate	DATE
AllergyIntolerance.onsetDateTime	DATE
AllergyIntolerance.onset	DATE
AllergyIntolerance.note	STRING

USCDI v3 Element Types:

USCDI Element	Supported Type
Substance (Drug Class)	RxNorm
Substance (Medication)	SNOMED CT
Reaction	SNOMED CT

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results

Example:
https://fhir.compulinkadvantage.com/[client_unique]/AllergyIntolerance?patient=[patient_unique]

MedicationRequest - US Core MedicationRequest Profile

US Core 6.1.0 USCDI v3 Required

FHIR Resource: MedicationRequest | USCDI v3 Domain: Medications

Supported Elements:

Resource Data Element	Data Type
MedicationRequest.status	STRING
MedicationRequest.intent	STRING
MedicationRequest.medication[x]	RxNorm
MedicationRequest.subject	REFERENCE
MedicationRequest.authoredOn	DATETIME
MedicationRequest.requester	REFERENCE
MedicationRequest.dosageInstruction	-
MedicationRequest.dosageInstruction.text	STRING
MedicationRequest.encounter	REFERENCE
MedicationRequest.reportedBoolean	BOOLEAN

USCDI v3 Element Types:

USCDI Element	Supported Type
Medications	RxNorm

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
intent	Filter by intent
status	Filter by status

Example:
https://fhir.compulinkadvantage.com/[client_unique]/MedicationRequest?_revinclude=Provenance:target&intent=proposal&patient=[patient_unique]

USCDI v3 Domain: Care Team & Care Planning

CarePlan - US Core CarePlan Profile

US Core 6.1.0 USCDI v3 Required

FHIR Resource: CarePlan | USCDI v3 Domain: Assessment and Plan of Treatment

Supported Elements:

Resource Data Element	Data Type
CarePlan.category	-
CarePlan.category:AssessPlan	FIXED
CarePlan.intent	STRING
CarePlan.status	STRING
CarePlan.subject	REFERENCE
CarePlan.text	STRING
CarePlan.text.status	STRING

USCDI v3 Element Types:

USCDI Element	Supported Type
Assessment and Plan of Treatment	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
category	Filter by category
patient	Patient results

Example:
https://fhir.compulinkadvantage.com/[client_unique]/CarePlan?category=assess-plan&patient=[patient_unique]

CareTeam - US Core CareTeam Profile

US Core 6.1.0 USCDI v3 Required

FHIR Resource: CareTeam | USCDI v3 Domain: Care Team and Care Coordination

Supported Elements:

Resource Data Element	Data Type
CareTeam.participant	-
CareTeam.participant.member	STRING
CareTeam.participant.role	STRING
CareTeam.status	STRING
CareTeam.subject	REFERENCE
CareTeam.encounter	REFERENCE

USCDI v3 Element Types:

USCDI Element	Supported Type
Care Team Members	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
status	Filter by status

Example:
https://fhir.compulinkadvantage.com/[client_unique]/CareTeam?patient=[patient_unique]&status=proposed

Goal - US Core Goal Profile

US Core 6.1.0 USCDI v3 Required

FHIR Resource: Goal | USCDI v3 Domain: Goals and Preferences

Supported Elements:

Resource Data Element	Data Type
Goal.description	STRING
Goal.lifecycleStatus	STRING
Goal.subject	REFERENCE
Goal.target.dueDate	DATE

USCDI v3 Element Types:

USCDI Element	Supported Type
Patient Goals	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Goal?patient=[patient_unique]

USCDI v3 Domain: Clinical Notes & Documents

DocumentReference - US Core DocumentReference Profile

US Core 6.1.0 USCDI v3 Required

FHIR Resource: DocumentReference | USCDI v3 Domain: Clinical Notes

Supported Elements:

Resource Data Element	Data Type
DocumentReference.author	REFERENCE
DocumentReference.category	STRING
DocumentReference.content	-
DocumentReference.content.attachment	-
DocumentReference.content.attachment.contentType	STRING
DocumentReference.content.attachment.url	URL
DocumentReference.content.format	STRING
DocumentReference.context.period	DATE
DocumentReference.custodian	REFERENCE
DocumentReference.encounter	REFERENCE
DocumentReference.date	DATE
DocumentReference.identifier	INTEGER
DocumentReference.status	STRING
DocumentReference.subject	REFERENCE
DocumentReference.type	LOINC

USCDI v3 Element Types:

USCDI Element	Supported Type
Consultation Note	LOINC
Discharge Summary Note
History & Physical
Progress Note
Imaging Narrative
Procedure Note
Laboratory Report Narrative
Pathology Report Narrative

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
type	Filter by type
category	Filter by category
date	Filter by date

Example:
https://fhir.compulinkadvantage.com/[client_unique]/DocumentReference?patient=[patient_unique]

DiagnosticReport (Notes) - US Core DiagnosticReport Profile for Report and Note Exchange

US Core 6.1.0 USCDI v3 Required

FHIR Resource: DiagnosticReport | USCDI v3 Domain: Clinical Notes

Supported Elements:

Resource Data Element	Data Type
DiagnosticReport.category	LOINC
DiagnosticReport.code	LOINC
DiagnosticReport.effectiveDateTime	DATETIME
DiagnosticReport.encounter	REFERENCE
DiagnosticReport.issued	DATETIME
DiagnosticReport.performer	REFERENCE
DiagnosticReport.presentedForm.URL	REFERENCE
DiagnosticReport.status	STRING
DiagnosticReport.subject	REFERENCE
DiagnosticReport.presentedForm	LOINC

USCDI v3 Element Types:

USCDI Element	Supported Type
Imaging Narrative	LOINC
Procedure Note
Laboratory Report Narrative
Pathology Report Narrative

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
code	Filter by code
category	Filter by category
date	Filter by date

Example:
https://fhir.compulinkadvantage.com/[client_unique]/DiagnosticReport?_revinclude=Provenance:target&category=LP29684-5&patient=[patient_unique]

USCDI v3 Domain: Laboratory

DiagnosticReport (Laboratory) - US Core DiagnosticReport Profile for Laboratory Results Reporting

US Core 6.1.0 USCDI v3 Required

FHIR Resource: DiagnosticReport | USCDI v3 Domain: Laboratory

Supported Elements:

Resource Data Element	Data Type
DiagnosticReport.category	LOINC
DiagnosticReport.code	LOINC
DiagnosticReport.effectiveDateTime	DATETIME
DiagnosticReport.encounter	REFERENCE
DiagnosticReport.issued	DATETIME
DiagnosticReport.performer	REFERENCE
DiagnosticReport.status	STRING
DiagnosticReport.subject	REFERENCE
DiagnosticReport.presentedForm	LOINC
DiagnosticReport.result	REFERENCE

USCDI v3 Element Types:

USCDI Element	Supported Type
Tests	LOINC
Results	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
code	Filter by code
category	Filter by category
date	Filter by date

Example:
https://fhir.compulinkadvantage.com/[client_unique]/DiagnosticReport?category=LAB&patient=[patient_unique]

Observation (Laboratory) - US Core Laboratory Result Observation Profile

US Core 6.1.0 USCDI v3 Required

FHIR Resource: Observation | USCDI v3 Domain: Laboratory

Supported Elements:

Resource Data Element	Data Type
Observation.status	STRING
Observation.category	FIXED (laboratory)
Observation.code	LOINC
Observation.subject	REFERENCE
Observation.effectiveDateTime	DATE
Observation.valueQuantity	-
Observation.valueQuantity.value	STRING
Observation.valueQuantity.unit	STRING
Observation.referenceRange	-
Observation.referenceRange.low.value	STRING
Observation.referenceRange.low.unit	STRING
Observation.referenceRange.high.value	STRING
Observation.referenceRange.high.unit	STRING

USCDI v3 Element Types:

USCDI Element	Supported Type
Tests	LOINC
Results	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
category	Filter by category
code	Filter by code
date	Filter by date

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Observation?category=laboratory&patient=[patient_unique]

ServiceRequest - US Core ServiceRequest Profile

US Core 6.1.0 USCDI v3 Required

FHIR Resource: ServiceRequest | USCDI v3 Domain: Laboratory & Diagnostic Imaging Orders

Supported Elements:

Resource Data Element	Data Type
ServiceRequest.status	STRING
ServiceRequest.intent	STRING
ServiceRequest.category	CodeableConcept (SNOMED CT, LOINC)
ServiceRequest.code	CodeableConcept (SNOMED CT, LOINC, CPT, HCPCS)
ServiceRequest.subject	REFERENCE (Patient)
ServiceRequest.authoredOn	DATETIME
ServiceRequest.requester	REFERENCE (Practitioner, Organization)

USCDI v3 Element Types:

USCDI Element	Supported Type
Laboratory Service Orders	LOINC
Diagnostic Imaging Service Orders	LOINC, SNOMED CT

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
category	Filter by category
code	Filter by code
authored	Filter by authored date

Example:
https://fhir.compulinkadvantage.com/[client_unique]/ServiceRequest?patient=[patient_unique]&category=108252007

Specimen - US Core Specimen Profile

US Core 6.1.0 USCDI v3 Required

FHIR Resource: Specimen | USCDI v3 Domain: Laboratory

Supported Elements:

Resource Data Element	Data Type
Specimen.identifier	Identifier
Specimen.accessionIdentifier	Identifier
Specimen.type	CodeableConcept (SNOMED CT)
Specimen.subject	REFERENCE (Patient)
Specimen.collection	-
Specimen.collection.collectedDateTime	DATETIME

USCDI v3 Element Types:

USCDI Element	Supported Type
Specimen Type	SNOMED CT
Specimen Identifier	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Specimen?patient=[patient_unique]

USCDI v3 Domain: Vital Signs & Clinical Observations

Goals - US Core Goal Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Goal resource

Supported Elements:

Resource Data Element	Data Type
Goal.description	STRING
Goal.lifecycleStatus	STRING
Goal.subject	REFERENCE
Goal.target.dueDate	DATE

USCDI v3 Element Types:

USCDI Element	Supported Type
Patient Goals	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Goal?patient=[patient_unique]

Health Concerns - US Core Condition Problems and Health Concerns Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Condition resource

Supported Elements:

Resource Data Element	Data Type
Condition.category	STRING, SNOMED CT
Condition.clinicalStatus	STRING
Condition.code	ICD-10, SNOMED CT
Condition.subject	REFERENCE
Condition.verificationStatus	STRING

USCDI v3 Element Types:

USCDI Element	Supported Type
Health Concerns	ICD-10, SNOMED CT

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
category	Filter by category

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Condition?patient=[patient_unique]

Problems - US Core Condition Problems and Health Concerns Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Condition resource

Supported Elements:

Resource Data Element	Data Type
Condition.category	STRING, SNOMED CT
Condition.clinicalStatus	STRING
Condition.code	SNOMED CT
Condition.subject	REFERENCE
Condition.verificationStatus	STRING

USCDI v3 Element Types:

USCDI Element	Supported Type
Problems	SNOMED CT

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
category	Filter by category

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Condition?patient=[patient_unique]

Immunizations - US Core Immunization Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Immunization resource

Supported Elements:

Resource Data Element	Data Type
Immunization.status	STRING
Immunization.statusReason	STRING
Immunization.vaccineCode	CVX
Immunization.patient	REFERENCE
Immunization.occurrenceString	STRING, DATETIME
Immunization.primarySource	BOOLEAN

USCDI v3 Element Types:

USCDI Element	Supported Type
Immunization	CVX

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Immunization?patient=[patient_unique]

Medications - US Core MedicationRequest Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? MedicationRequest resource

Supported Elements:

Resource Data Element	Data Type
MedicationRequest.status	STRING
MedicationRequest.intent	STRING
MedicationRequest.medication[x]	RxNorm
MedicationRequest.subject	REFERENCE
MedicationRequest.authoredOn	DATETIME
MedicationRequest.requester	REFERENCE
MedicationRequest.dosageInstruction	-
MedicationRequest.dosageInstruction.text	STRING
MedicationRequest.encounter	REFERENCE
MedicationRequest.reportedBoolean	BOOLEAN

USCDI v3 Element Types:

USCDI Element	Supported Type
Medications	RxNorm

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
intent	Filter by intent
status	Filter by status

Example:
https://fhir.compulinkadvantage.com/[client_unique]/MedicationRequest?_revinclude=Provenance:target&intent=proposal&patient=[patient_unique]

Procedures - US Core Procedure Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Procedure resource

Supported Elements:

Resource Data Element	Data Type
Procedure.status	STRING
Procedure.code	SNOMED CT, CPT, HCPCS
Procedure.subject	REFERENCE
Procedure.performedDateTime	DATE

USCDI v3 Element Types:

USCDI Element	Supported Type
Procedures	SNOMED CT, CPT, HCPCS

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
date	Filter by date

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Procedure?patient=[patient_unique]

Unique Device Identifier(s) for Patient's Implantable Device(s) - US Core Implantable Device Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Device resource

Supported Elements:

Resource Data Element	Data Type
Device.udiCarrier	STRING
Device.udiCarrier.deviceIdentifier	STRING
Device.udiCarrier.carrierAIDC or Device.udiCarrier.carrierHRF	STRING
Device.distinctIdentifier	STRING
Device.manufactureDate	DATE
Device.expirationDate	DATE
Device.lotNumber	INTEGER
Device.serialNumber	STRING
Device.type	SNOMED CT
Device.patient	REFERENCE

USCDI v3 Element Types:

USCDI Element	Supported Type
Unique Device Identifier	UDI

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Device?_revinclude=Provenance:target&patient=[patient_unique]

Laboratory - US Core Laboratory Result Observation Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Observation resource (may be referenced in DiagnosticReport resource)

Supported Elements:

Resource Data Element	Data Type
Observation.status	STRING
Observation.category	FIXED (laboratory)
Observation.code	LOINC
Observation.subject	REFERENCE
Observation.effectiveDateTime	DATE
Observation.valueQuantity	-
Observation.valueQuantity.value	STRING
Observation.valueQuantity.unit	STRING
Observation.referenceRange	-
Observation.referenceRange.low.value	STRING
Observation.referenceRange.low.unit	STRING
Observation.referenceRange.high.value	STRING
Observation.referenceRange.high.unit	STRING

USCDI v3 Element Types:

USCDI Element	Supported Type
Tests	LOINC
Results	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
category	Filter by category
code	Filter by code
date	Filter by date

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Observation?category=laboratory&patient=[patient_unique]

Smoking Status - US Core Smoking Status Observation Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Observation resource

Supported Elements:

Resource Data Element	Data Type
Observation.status	STRING
Observation.code	FIXED (72166-2)
Observation.subject	REFERENCE
Observation.issued	DATE
Observation.value[x]:valueCodeableConcept	SNOMED CT

USCDI v3 Element Types:

USCDI Element	Supported Type
Smoking Status	SNOMED CT

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
code	Filter by code

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Observation?code=72166-2&patient=[patient_unique]

Vital Signs - US Core Vital Signs Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Observation resource

Available Vital Signs Panel Options:

Diastolic Blood Pressure - Blood pressure systolic and diastolic (FHIR Core Profile)
Systolic Blood Pressure - Blood pressure systolic and diastolic (FHIR Core Profile)
Body Height - Body height (FHIR Core Profile)
Body Weight - Body weight (FHIR Core Profile)
Heart Rate - Heart rate (FHIR Core Profile)
Respiratory Rate - Respiratory rate (FHIR Core Profile)
Body Temperature - Body temperature (FHIR Core Profile)
Pulse Oximetry - US Core Pulse Oximetry Profile
Inhaled Oxygen Concentration - US Core Pulse Oximetry Profile
BMI Percentile (2-20 years old) - US Core Pediatric BMI for Age Observation Profile
Weight-for-Length Percentile (Birth-36 months) - US Core Pediatric Weight for Height Observation Profile
Occipital-frontal Head Circumference Percentile (Birth-36 months) - US Core Pediatric Head Occipital-Frontal Circumference Observation Profile

Supported Elements:

Resource Data Element	Data Type
Observation.status	STRING
Observation.category	-
Observation.category.coding.code	FIXED (vital-signs)
Observation.code.coding.code	LOINC
Observation.subject	REFERENCE
Observation.effectiveDateTime	DATE
Observation.value[x]	-
Observation.value[x]:valueQuantity	STRING
Observation.value[x].value	STRING
Observation.value[x].unit	STRING
Observation.value[x].system	STRING
Observation.value[x].code	LOINC

USCDI v3 Element Types:

USCDI Element	Supported Type
Systolic Blood Pressure	LOINC
Diastolic Blood Pressure
Heart Rate
Respiratory Rate
Body Temperature
Body Height
Body Weight
Pulse Oximetry
Inhaled Oxygen Concentration
BMI Percentile (2-20 years)
Weight-for-Length Percentile (Birth-36 months)
Head Occipital-Frontal Circumference Percentile (Birth-36 months)

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
category	Filter by category
code	Filter by code
date	Filter by date

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Observation?category=vital-signs&patient=[patient_unique]

Health Insurance Information - US Core Coverage Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Coverage resource

Supported Elements:

Resource Data Element	Data Type
Coverage.status	STRING
Coverage.type	CodeableConcept
Coverage.subscriberId	STRING
Coverage.beneficiary	REFERENCE (Patient)
Coverage.relationship	CodeableConcept
Coverage.payor	REFERENCE (Organization, Patient, RelatedPerson)
Coverage.class	-
Coverage.class:group	-
Coverage.class:group.type	CodeableConcept (FIXED: group)
Coverage.class:group.value	STRING (Group Number)
Coverage.class:plan	-
Coverage.class:plan.type	CodeableConcept (FIXED: plan)
Coverage.class:plan.value	STRING (Plan Number)

USCDI v3 Element Types:

USCDI Element	Supported Type
Coverage Status	N/A
Coverage Type	N/A
Relationship to Subscriber	N/A
Member Identifier	N/A
Subscriber Identifier	N/A
Group Number	N/A
Plan Number	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Coverage?patient=[patient_unique]

Related Person - US Core RelatedPerson Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? RelatedPerson resource (may be referenced in Coverage and CareTeam resources)

Supported Elements:

Resource Data Element	Data Type
RelatedPerson.active	BOOLEAN
RelatedPerson.patient	REFERENCE (Patient)
RelatedPerson.relationship	CodeableConcept
RelatedPerson.name	-
RelatedPerson.name.family	STRING
RelatedPerson.name.given	STRING
RelatedPerson.telecom	-
RelatedPerson.telecom.system	STRING
RelatedPerson.telecom.value	STRING
RelatedPerson.address	-
RelatedPerson.address.line	STRING
RelatedPerson.address.city	STRING
RelatedPerson.address.state	STRING
RelatedPerson.address.postalCode	STRING

USCDI v3 Element Types:

USCDI Element	Supported Type
Related Person Name	N/A
Related Person Relationship	N/A
Related Person Contact	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results

Example:
https://fhir.compulinkadvantage.com/[client_unique]/RelatedPerson?patient=[patient_unique]

Service Request - US Core ServiceRequest Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? ServiceRequest resource

Supported Elements:

Resource Data Element	Data Type
ServiceRequest.status	STRING
ServiceRequest.intent	STRING
ServiceRequest.category	CodeableConcept (SNOMED CT, LOINC)
ServiceRequest.code	CodeableConcept (SNOMED CT, LOINC, CPT, HCPCS)
ServiceRequest.subject	REFERENCE (Patient)
ServiceRequest.authoredOn	DATETIME
ServiceRequest.requester	REFERENCE (Practitioner, Organization)

USCDI v3 Element Types:

USCDI Element	Supported Type
Laboratory Service Orders	LOINC
Diagnostic Imaging Service Orders	LOINC, SNOMED CT

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
category	Filter by category
code	Filter by code
authored	Filter by authored date

Example:
https://fhir.compulinkadvantage.com/[client_unique]/ServiceRequest?patient=[patient_unique]&category=108252007

Specimen - US Core Specimen Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Specimen resource (may be referenced in DiagnosticReport and Observation resources)

Supported Elements:

Resource Data Element	Data Type
Specimen.identifier	Identifier
Specimen.accessionIdentifier	Identifier
Specimen.type	CodeableConcept (SNOMED CT)
Specimen.subject	REFERENCE (Patient)
Specimen.collection	-
Specimen.collection.collectedDateTime	DATETIME

USCDI v3 Element Types:

USCDI Element	Supported Type
Specimen Type	SNOMED CT
Specimen Identifier	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Specimen?patient=[patient_unique]

Encounter Diagnosis - US Core Condition Encounter Diagnosis Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Condition resource

Supported Elements:

Resource Data Element	Data Type
Condition.category	CodeableConcept (FIXED: encounter-diagnosis)
Condition.code	CodeableConcept (SNOMED CT, ICD-10-CM)
Condition.subject	REFERENCE (Patient)
Condition.encounter	REFERENCE (Encounter)

USCDI v3 Element Types:

USCDI Element	Supported Type
Encounter Diagnosis	SNOMED CT, ICD-10-CM

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
category	Filter by category

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Condition?patient=[patient_unique]&category=encounter-diagnosis

Screening and Assessments - US Core Observation Screening Assessment Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Observation resource

US Core 6.1.0 Patch (FHIR-45319)

We support all four codes from the US Core Screening Assessment Observation Category ValueSet:

social-history
functional-mental-status
disability-status
cognitive-status

Supported Elements:

Resource Data Element	Data Type
Observation.status	STRING
Observation.category	-
Observation.category:us-core	CodeableConcept
Observation.category:screening-assessment	CodeableConcept (social-history, functional-mental-status, disability-status, cognitive-status)
Observation.code	CodeableConcept (LOINC)
Observation.subject	REFERENCE (Patient)
Observation.effectiveDateTime	DATETIME
Observation.value[x]	Multiple types supported
Observation.derivedFrom	REFERENCE (QuestionnaireResponse, DocumentReference, Observation)

USCDI v3 Element Types:

USCDI Element	Supported Type
SDOH Assessments	LOINC
Functional Status	LOINC
Disability Status	LOINC
Mental/Cognitive Status	LOINC

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
category	Filter by category
code	Filter by code
date	Filter by date

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Observation?patient=[patient_unique]&category=social-history

Clinical Test Results - US Core Observation Clinical Result Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Observation resource (may be referenced in DiagnosticReport resource)

Supported Elements:

Resource Data Element	Data Type
Observation.status	STRING
Observation.category	CodeableConcept (clinical-test)
Observation.code	CodeableConcept (LOINC)
Observation.subject	REFERENCE (Patient)
Observation.effectiveDateTime	DATETIME
Observation.value[x]	Multiple types supported

USCDI v3 Element Types:

USCDI Element	Supported Type
Clinical Tests	LOINC
Clinical Test Results	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
category	Filter by category
code	Filter by code
date	Filter by date

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Observation?patient=[patient_unique]&category=clinical-test

Location - US Core Location Profile

US Core 6.1.0

Where is it used? Location resource (may be referenced in Encounter resource)

Supported Elements:

Resource Data Element	Data Type
Location.status	STRING
Location.name	STRING
Location.telecom	-
Location.telecom.system	STRING
Location.telecom.value	STRING
Location.address	-
Location.address.line	STRING
Location.address.city	STRING
Location.address.state	STRING
Location.address.postalCode	STRING
Location.managingOrganization	REFERENCE (Organization)

Search Methods:

Search	Type
id	Direct result
_search	Search results
name	Filter by name
address	Filter by address

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Location/[location_unique]

Practitioner Role - US Core PractitionerRole Profile

US Core 6.1.0

Where is it used? PractitionerRole resource (may be referenced in CareTeam, Encounter resources)

Supported Elements:

Resource Data Element	Data Type
PractitionerRole.practitioner	REFERENCE (Practitioner)
PractitionerRole.organization	REFERENCE (Organization)
PractitionerRole.code	CodeableConcept
PractitionerRole.specialty	CodeableConcept
PractitionerRole.location	REFERENCE (Location)
PractitionerRole.telecom	-
PractitionerRole.telecom.system	STRING
PractitionerRole.telecom.value	STRING
PractitionerRole.endpoint	REFERENCE (Endpoint)

Search Methods:

Search	Type
id	Direct result
_search	Search results
specialty	Filter by specialty
practitioner	Filter by practitioner

Example:
https://fhir.compulinkadvantage.com/[client_unique]/PractitionerRole/[practitionerrole_unique]

Patient - US Core Patient Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Patient resource (may also be referenced in AllergyIntolerance, CarePlan, CareTeam, Condition, Device, DiagnosticReport, DocumentReference, Goal, Immunization, MedicationRequest, Observation, Procedure, and Encounter resources)

Supported Elements:

Resource Data Element	Data Type
Patient.identifier	REFERENCE
Patient.name	-
Patient.name.family	STRING
Patient.name.given	STRING
Patient.name.suffix	STRING
Patient.name.period.start	DATE
Patient.name.period.end	DATE
Patient.birthDate	DATE
Patient.gender	STRING
Patient.address	-
Patient.address.line	STRING
Patient.address.city	STRING
Patient.address.state	STRING
Patient.address.postalCode	STRING
Patient.address.period	DATE
Patient.telecom	-
Patient.telecom.use	STRING
Patient.telecom.value	STRING
Patient.communication	-
Patient.communication.language	STRING
Patient.extension:race	STRING
Patient.extension:ethnicity	STRING
Patient.extension:birthsex	STRING

USCDI v3 Element Types:

USCDI Element	Supported Type
First Name	N/A
Last Name	N/A
Middle Name	N/A
Suffix	N/A
Previous Name	N/A
Date of Birth	N/A
Sex (Birth)	See 45 CFR 170.207(n)
Race	See 45 CFR 170.207(f)
Ethnicity	See 45 CFR 170.207(f)
Preferred Language	See 45 CFR 170.207(g)
Current Address	N/A
Previous Address	N/A
Phone Number	See 45 CFR 170.207(q)(1)
Phone Number Type	N/A
Email Address	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
birthdate	Filter by birth date
name	Filter by name
gender	Filter by gender

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Patient?birthdate=1980-12-01&name=SAMPLE

RelatedPerson - US Core RelatedPerson Profile

US Core 6.1.0 USCDI v3 Required

FHIR Resource: RelatedPerson | USCDI v3 Domain: Patient Demographics

Supported Elements:

Resource Data Element	Data Type
RelatedPerson.active	BOOLEAN
RelatedPerson.patient	REFERENCE (Patient)
RelatedPerson.relationship	CodeableConcept
RelatedPerson.name	-
RelatedPerson.name.family	STRING
RelatedPerson.name.given	STRING
RelatedPerson.telecom	-
RelatedPerson.telecom.system	STRING
RelatedPerson.telecom.value	STRING
RelatedPerson.address	-
RelatedPerson.address.line	STRING
RelatedPerson.address.city	STRING
RelatedPerson.address.state	STRING
RelatedPerson.address.postalCode	STRING

USCDI v3 Element Types:

USCDI Element	Supported Type
Related Person Name	N/A
Related Person Relationship	N/A
Related Person Contact	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results

Example:
https://fhir.compulinkadvantage.com/[client_unique]/RelatedPerson?patient=[patient_unique]

USCDI v3 Domain: Health Insurance

Coverage - US Core Coverage Profile

US Core 6.1.0 USCDI v3 Required

FHIR Resource: Coverage | USCDI v3 Domain: Health Insurance Information

Supported Elements:

Resource Data Element	Data Type
Coverage.status	STRING
Coverage.type	CodeableConcept
Coverage.subscriberId	STRING
Coverage.beneficiary	REFERENCE (Patient)
Coverage.relationship	CodeableConcept
Coverage.payor	REFERENCE (Organization, Patient, RelatedPerson)
Coverage.class	-
Coverage.class:group	-
Coverage.class:group.type	CodeableConcept (FIXED: group)
Coverage.class:group.value	STRING (Group Number)
Coverage.class:plan	-
Coverage.class:plan.type	CodeableConcept (FIXED: plan)
Coverage.class:plan.value	STRING (Plan Number)

USCDI v3 Element Types:

USCDI Element	Supported Type
Coverage Status	N/A
Coverage Type	N/A
Relationship to Subscriber	N/A
Member Identifier	N/A
Subscriber Identifier	N/A
Group Number	N/A
Plan Number	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Coverage?patient=[patient_unique]

USCDI v3 Domain: Problems & Health Concerns

Condition (Health Concerns) - US Core Condition Problems and Health Concerns Profile

US Core 6.1.0 USCDI v3 Required

FHIR Resource: Condition | USCDI v3 Domain: Problems & Health Concerns

Supported Elements:

Resource Data Element	Data Type
Condition.category	STRING, SNOMED CT (health-concern)
Condition.clinicalStatus	STRING
Condition.code	ICD-10, SNOMED CT
Condition.subject	REFERENCE
Condition.verificationStatus	STRING

USCDI v3 Element Types:

USCDI Element	Supported Type
Health Concerns	ICD-10, SNOMED CT

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
category	Filter by category

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Condition?patient=[patient_unique]&category=health-concern

Condition (Problems) - US Core Condition Problems and Health Concerns Profile

US Core 6.1.0 USCDI v3 Required

FHIR Resource: Condition | USCDI v3 Domain: Problems & Health Concerns

Supported Elements:

Resource Data Element	Data Type
Condition.category	STRING, SNOMED CT (problem-list-item)
Condition.clinicalStatus	STRING
Condition.code	SNOMED CT
Condition.subject	REFERENCE
Condition.verificationStatus	STRING

USCDI v3 Element Types:

USCDI Element	Supported Type
Problems	SNOMED CT

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
category	Filter by category

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Condition?patient=[patient_unique]&category=problem-list-item

Condition (Encounter Diagnosis) - US Core Condition Encounter Diagnosis Profile

US Core 6.1.0 USCDI v3 Required

FHIR Resource: Condition | USCDI v3 Domain: Problems & Health Concerns

Supported Elements:

Resource Data Element	Data Type
Condition.category	CodeableConcept (FIXED: encounter-diagnosis)
Condition.code	CodeableConcept (SNOMED CT, ICD-10-CM)
Condition.subject	REFERENCE (Patient)
Condition.encounter	REFERENCE (Encounter)

USCDI v3 Element Types:

USCDI Element	Supported Type
Encounter Diagnosis	SNOMED CT, ICD-10-CM

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results
category	Filter by category

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Condition?patient=[patient_unique]&category=encounter-diagnosis

USCDI v3 Domain: Medications & Allergies

c. Additional Categories

These requests are available but may not be specific to a patient.

Encounter - US Core Encounter Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Encounter resource (may also be referenced in CareTeam, Condition, DiagnosticReport, DocumentReference, and MedicationRequest resources)

Supported Elements:

Resource Data Element	Data Type
Encounter.status	STRING
Encounter.class	-
Encounter.type	STRING
Encounter.subject	REFERENCE
Encounter.participant	-
Encounter.participant.type	STRING
Encounter.participant.period	DATE
Encounter.participant.individual	REFERENCE
Encounter.period	DATE
Encounter.reasonCode	STRING
Encounter.hospitalization	STRING
Encounter.hospitalization.dischargeDisposition	STRING
Encounter.location	-
Encounter.location.location	REFERENCE

Search Methods:

Search	Type
id	Direct result
_search	Search results
patient	Patient results

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Encounter/[encounter_unique]

Practitioner - US Core Practitioner Profile

US Core 6.1.0

Where is it used? Practitioner resource (may also be referenced in CareTeam, DiagnosticReport, DocumentReference, MedicationRequest, and Encounter resources)

Supported Elements:

Resource Data Element	Data Type
Practitioner.identifier	-
Practitioner.identifier.value	NPI
Practitioner.name	-
Practitioner.name.family	STRING
Practitioner.name.given	STRING
Practitioner.name.prefix	STRING
Practitioner.name.suffix	STRING
Practitioner.telecom	-
Practitioner.telecom.use	STRING
Practitioner.telecom.value	STRING
Practitioner.address	-
Practitioner.address.line	STRING
Practitioner.address.city	STRING
Practitioner.address.state	STRING
Practitioner.address.postalCode	STRING

Search Methods:

Search	Type
id	Direct result
_search	Search results
name	Filter by name

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Practitioner/[practitioner_unique]

Organization - US Core Organization Profile

US Core 6.1.0

Where is it used? Organization resource (may also be referenced in Encounter and Provenance resources)

Supported Elements:

Resource Data Element	Data Type
Organization.active	BOOLEAN
Organization.identifier	NPI
Organization.name	STRING
Organization.telecom	-
Organization.telecom.system	STRING
Organization.telecom.value	STRING
Organization.address	-
Organization.address.line	STRING
Organization.address.city	STRING
Organization.address.state	STRING
Organization.address.postalCode	STRING
Organization.address.country	STRING

Search Methods:

Search	Type
id	Direct result
_search	Search results
name	Filter by name

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Organization/[organization_unique]

Provenance - US Core Provenance Profile

US Core 6.1.0 USCDI v3 Required

Where is it used? Provenance resource (may be referenced with any clinical resource to track authorship and data origin)

Supported Elements:

Resource Data Element	Data Type
Provenance.target	REFERENCE
Provenance.recorded	DATETIME
Provenance.agent	-
Provenance.agent.type	STRING
Provenance.agent.type.coding.code	STRING
Provenance.agent.who	REFERENCE
Provenance.agent.onBehalfOf	REFERENCE
Provenance.agent:ProvenanceAuthor	STRING
Provenance.agent:ProvenanceTransmitter	STRING

USCDI v3 Element Types:

USCDI Element	Supported Type
Author Time Stamp	N/A
Author Organization	N/A

Search Methods:

Search	Type
id	Direct result
_search	Search results
_revinclude=Provenance:target	Include in other resources

Example:
https://fhir.compulinkadvantage.com/[client_unique]/Observation?_revinclude=Provenance:target&category=laboratory&patient=[patient_unique]

4. Usage Terms

a. Fees and Limitations

Usage of our standard API as listed above does not contain any additional fees. Data owner (such as medical office) must retain an active Advantage Partnership Support Service agreement.

Costs and Limitations are publicly available at: Disclosure-Analysis-Costs-and-Limitations

b. Restrictions and Obligations

Any user shall be restricted to the data and scopes made available to that user. That usage shall be in the context of the information provided in registration.

Compulink or the data owner (such as the medical organization) reserve the right to remove or restrict access to users. Other reasons for removal include, but are not limited to:

Sublicense or share any protected connectivity content from the API for use by a non-registered application.
Perform an action with the intent of introducing the interface to any viruses, worms, defects, Trojan horses, malware, or any items of a destructive nature.
Defame, abuse, harass, stalk, or threaten others.
Interfere with or disrupt the APIs or the servers or networks providing the APIs.
Reverse engineer or attempt to extract the source code from any API or any related software, except to the extent that this restriction is expressly prohibited by applicable law.
Collecting data outside the agreed upon context of usage.

You may not use the APIs and may not accept the Terms if you are a person barred from using or receiving the APIs under the applicable laws of the United States or other countries including the country in which you are resident or from which you use the APIs.

c. Contact

For any developer related question or clarifications regarding Compulink FHIR API please contact:

Compulink Customer Care

Phone: 805.716.8677
Fax: 805.497.4983
Email: [email protected]

FHIR API Documentation

Table of Contents

1. Introduction

2. Registration & Authentication

a. Application Access Requests

b. Connecting to the Server

c. Authentication - Registering an Application

d. Authentication - Refresh Token

e. Authentication - Additional Users/Patient

f. Revoking Authentication

3. API Details

a. FHIR Resources by USCDI v3 Domain

USCDI v3 Domain: Patient Demographics

Allergies and Intolerances - US Core AllergyIntolerance Profile

Supported Elements:

USCDI v3 Element Types:

Search Methods:

MedicationRequest - US Core MedicationRequest Profile

Supported Elements:

USCDI v3 Element Types:

Search Methods:

USCDI v3 Domain: Care Team & Care Planning

CarePlan - US Core CarePlan Profile

Supported Elements:

USCDI v3 Element Types:

Search Methods:

CareTeam - US Core CareTeam Profile

Supported Elements:

USCDI v3 Element Types:

Search Methods:

Goal - US Core Goal Profile

Supported Elements:

USCDI v3 Element Types:

Search Methods:

USCDI v3 Domain: Clinical Notes & Documents

DocumentReference - US Core DocumentReference Profile

Supported Elements:

USCDI v3 Element Types:

Search Methods:

DiagnosticReport (Notes) - US Core DiagnosticReport Profile for Report and Note Exchange

Supported Elements:

USCDI v3 Element Types:

Search Methods:

USCDI v3 Domain: Laboratory

DiagnosticReport (Laboratory) - US Core DiagnosticReport Profile for Laboratory Results Reporting

Supported Elements:

USCDI v3 Element Types:

Search Methods:

Observation (Laboratory) - US Core Laboratory Result Observation Profile

Supported Elements:

USCDI v3 Element Types:

Search Methods:

ServiceRequest - US Core ServiceRequest Profile

Supported Elements:

USCDI v3 Element Types:

Search Methods:

Specimen - US Core Specimen Profile

Supported Elements:

USCDI v3 Element Types:

Search Methods:

USCDI v3 Domain: Vital Signs & Clinical Observations

Goals - US Core Goal Profile

Supported Elements:

USCDI v3 Element Types:

Search Methods:

Health Concerns - US Core Condition Problems and Health Concerns Profile

Supported Elements:

USCDI v3 Element Types:

Search Methods:

Problems - US Core Condition Problems and Health Concerns Profile

Supported Elements:

USCDI v3 Element Types:

Search Methods:

Immunizations - US Core Immunization Profile

Supported Elements:

USCDI v3 Element Types:

Search Methods:

Medications - US Core MedicationRequest Profile

Supported Elements:

USCDI v3 Element Types: