HealthLX : FHIR Starter Pak [R2]

Capability Statement
General Parameters
Resource Interactions
Resource Operations
Summary

Capability Statement

A list of supported functionalities of the FHIR Server for the specific FHIR version is available at:

GET [FHIR_SERVER_BASE_URL]/metadata

General Parameters

The server supports the general parameter _format which specifies the format of the response and overrides the Accept header.

A list of supported format values:

xml, text/xml, application/xml are treated as application/xml;
application/fhir+xml are treated as application/fhir+xml;
json, application/json are treated as application/json;
application/fhir+json are treated as application/fhir+json;

If the non-supported _format parameter is provided, the server attempts to use the Content-Type header of the request.

Resource Interactions

FHIR Resources

Interactions

Foundation Module (Level 1)

DocumentReference, Questionnaire

Security and Privacy Module (Level 2)

Provenance

Conformance Module (Level 2)

StructureDefinition, OperationDefinition

Administration Module (Level 3)

Patient, RelatedPerson, Group, Practitioner, PractitionerRole, Organization, OrganizationAffiliation, Location, HealthcareService, Endpoint, EpisodeOfCare, CommunicationRequest, Encounter, Appointment, Account, Device, DeviceDefinition, Substance

Clinical Module (Level 4)

AllergyIntolerance, Condition, Procedure, CarePlan, Goal, CareTeam, ClinicalImpression, DetectedIssue, RiskAssessment

Diagnostic Medicine Module (Level 4)

Observation, DiagnosticReport, ServiceRequest

Medications Module (Level 4)

MedicationRequest, MedicationDispense, MedicationAdministration, MedicationStatement, Medication, Immunization, ImmunizationRecommendation

Workflow Module (Level 4)

Task, NutritionOrder, VisionPrescription, DeviceRequest

Financial Module (Level 4)

Claim, Coverage, ClaimResponse, ExplanationOfBenefit

Clinical Reasoning Module (Level 5)

ActivityDefinition, Measure, PlanDefinition, RequestGroup

CREATE
Creates a new resource with a server assigned id.

POST [FHIR_SERVER_BASE_URL]/[Type]{?_format=[mime-type]}

UPDATE
Updates an existing resource by its id or creates a new one if the specified id was not found.
```
PUT [FHIR_SERVER_BASE_URL]/[Type]/[Id]{?_format=[mime-type]}
```

PATCH
Update an existing resource by posting a set of changes to it

PATCH [FHIR_SERVER_BASE_URL]/[Type]/[id]{?_format=[mime-type]}
Content-Type: application/json-patch+json

READ
Reads the current state of the resource.

GET [FHIR_SERVER_BASE_URL]/[Type]/[Id]{?_format=[mime-type]}

SEARCH
Searches the resource type based on some filter criteria.
```
GET [FHIR_SERVER_BASE_URL]/[type]{?[parameters]{&_format=[mime-type]}
```
```
POST  [FHIR_SERVER_BASE_URL]/[type]/_search{?[parameters]}{&_format=[mime-type]}
Content-Type: application/x-www-form-urlencoded
```
The server enforces case-sensitivity on search parameter names and search values.
Search parameters implementation notes:
- Reference parameter patient supports the following interpretations:
  - patient=[Id];
  - patient=[Type]/[Id];
  - patient=[URL].
- Search parameters of the date type support the following comparators: eq,gt,lt,ge,le,eb;
- Search parameter status supports the composite OR search: status={[system]}|[code],{[system]}|[code],..;

Resource Operations

Supported by the current version [R2] of the FHIR server operations

Patient-everything

Patient-everything operation fetches at least the patient record, as well its linked resource and resources that have a reference on the patient.

GET [FHIR_SERVER_BASE_URL]/[Type]/[Id]/$everything

The server supports paging through the results set using the _count(default _count=10) parameter and bundle links.

_include

_include of PractitionerRole

The server supports _include parameter that returns a list of matching resources and any directly referred resources by practitioner roles that reference the query results.

GET [FHIR_SERVER_BASE_URL]/PractitionerRole?_include=PractitionerRole:organization{&[parameters]}

The server also supports _include operation for PractitionerRole:organization with :iterate modifier to perform iterative inclusion of matching resources and any dirrectly referred resources of included practitioner roles.

GET [FHIR_SERVER_BASE_URL]/Practitioner?_revinclude=PractitionerRole:practitioner&_include:iterate=PractitionerRole:organization{&[parameters]}

_include of HealthcareService

The server supports _include parameter that returns a list of matching resources and any directly referred resources by healthcare services that reference the query results.

GET [FHIR_SERVER_BASE_URL]/HealthcareService?_include=HealthcareService:organization{&[parameters]}

_include of OrganizationAffiliation

The server supports _include parameter that returns a list of matching resources and any directly referred resources by organization affiliations that reference the query results.

GET [FHIR_SERVER_BASE_URL]/OrganizationAffiliation?_include=OrganizationAffiliation:participating-organization{&[parameters]}

_revinclude

_revinclude of Provenance

The server supports _revinclude parameter that returns a list of matching resources and any related provenance records that reference the query results.

GET [FHIR_SERVER_BASE_URL]/Observation?_revinclude=Provenance:target{&[parameters]}

_revinclude of Location

The server supports _revinclude parameter that returns a list of matching resources and any related location records that reference the query results.

GET [FHIR_SERVER_BASE_URL]/Organization?_revinclude=Location:organization{&[parameters]}

_revinclude of HealthcareService

The server supports _revinclude parameter that returns a list of matching resources and any related service records that reference the query results.

GET [FHIR_SERVER_BASE_URL]/Organization?_revinclude=HealthcareService:organization{&[parameters]}

_revinclude of Endpoint

The server supports _revinclude parameter that returns a list of matching resources and any direct addresses that reference the query results.

GET [FHIR_SERVER_BASE_URL]/Organization?_revinclude=Endpoint:organization{&[parameters]}

_revinclude of OrganizationAffiliation

The server supports _revinclude parameter that returns a list of matching resources and any related affiliation organization records that reference the query results.

GET [FHIR_SERVER_BASE_URL]/Organization?_revinclude=OrganizationAffiliation:participating-organization{&[parameters]}

GET [FHIR_SERVER_BASE_URL]/Organization?_revinclude=OrganizationAffiliation:network{&[parameters]}

_revinclude of PractitionerRole

The server supports _revinclude parameter that returns a list of matching resources and any related practitioner role records that reference the query results.

GET [FHIR_SERVER_BASE_URL]/Practitioner?_revinclude=PractitionerRole:practitioner{&[parameters]}

GET [FHIR_SERVER_BASE_URL]/Organization?_revinclude=PractitionerRole:network{&[parameters]}

Summary

FHIR Resource	Interactions	Search Parameter/ [Type]	$everything for the patient	Conformance to the US Core profile (search parameters)
Account	read	`_id` [token]	subject.reference
	create	`_profile` [uri]	guarantor.party.reference
	update	`patient` [reference]
	search-type
	patch
ActivityDefinition	read	`_id` [token]
	create	`_profile` [uri]
	update
	search-type
	patch
AllergyIntolerance	read	`_id` [token]	patient.reference	US Core AllergyIntolerance Profile
	create	`_profile` [uri]	recorder.reference
	update	`patient` [reference]	asserter.reference
	search-type
	patch
Appointment	read	`_id` [token]	participant.actor.reference
	create	`_profile` [uri]	supportingInformation.reference
	update	`patient` [reference]
	search-type
	patch
CarePlan	read	`_id` [token]	subject.reference	US Core CarePlan Profile
	create	`_profile` [uri]	author.reference
	update	`patient` [reference]	contributor.reference
	search-type	`category` [token]	performer.reference
	patch	`category` [token]	performer.reference
CareTeam	read	`_id` [token]	subject.reference	US Core CareTeam Profile
	create	`_profile` [uri]	participant.member.reference
	update	`patient` [reference]
	search-type	`status` [token]
	patch	`status` [token]
Claim	read	`_id` [token]	patient.reference
	create	`_profile` [uri]	payee.party.reference
	update	`patient` [reference]
	search-type
	patch
ClaimResponse	read	`_id` [token]	patient.reference
	create	`_profile` [uri]
	update	`patient` [reference]
	search-type
	patch
ClinicalImpession	read	`_id` [token]	subject.reference
	create	`_profile` [uri]	supportingInfo.reference
	update	`patient` [reference]
	search-type
	patch
CommunicationRequest	read	`_id` [token]	basedOn.reference
	create	`_profile` [uri]	subject.reference
	update	`patient` [reference]	requester.reference;
	search-type		recipient.reference;
	patch		sender.reference;
Condition	read	`_id` [token]	subject.reference	US Core Condition Profile
	create	`_profile` [uri]	recorder.reference
	update	`patient` [reference]	asserter.reference
	search-type
	patch
Coverage	read	`_id` [token]	policyHolder.references
	create	`_profile` [uri]	subscriber.references
	update	`patient` [reference]	beneficiary.references
	search-type		payor.references
	patch		payor.references
DetectedIssue	read	`_id` [token]	patient.reference
	create	`_profile` [uri]	implicated.reference
	update	`patient` [reference]	evidence.detail.reference
	search-type
	patch
Device	read	`_id` [token]	patient.reference
	create	`_profile` [uri]
	update	`patient` [reference]
	search-type
	patch
DeviceDefinition	read	`_id` [token]
	create	`_profile` [uri]
	update
	search-type
	patch
DeviceRequest	read	`_id` [token]	basedOn.reference
	create	`_profile` [uri]	priorRequest.reference
	update	`patient` [reference]	subject.reference
	search-type		performer.reference
	patch		performer.reference
DiagnosticReport	read	`_id` [token]	subject.reference	US Core DiagnosticReport for Laboratory Results Reporting US Core DiagnosticReport Profile for Laboratory Results Reporting
	create	`_profile` [uri]
	update	`patient` [reference]
	search-type	`category` [token]
	patch	`code` [token]
	patch	`date` [date]
DocumentReference	read	`_id` [token]	subject.reference	US Core DocumentReference Profile
	create	`_profile` [uri]	author.reference
	update	`patient` [reference]	context.sourcePatientInfo.reference
	search-type	`category` [token]
	patch	`type` [token]
	patch	`date` [date]
Encounter	read	`_id` [token]	subject.reference	US Core Encounter Profile
	create	`_profile` [uri]
	update	`patient` [reference]
	search-type	`date` [date]
	patch	`status` [token]
Endpoint	read	`_id` [token]
	create	`_profile` [uri]
	update
	search-type
	patch
EpisodeOfCare	read	`_id` [token]	patient.reference;
	create	`_profile` [uri]
	update	`patient` [reference]
	search-type
	patch
ExplanationOfBenefit	read	`_id` [token]	patient.references
	create	`_profile` [uri]	payee.party.references
	update	`patient` [reference]
	search-type
	patch
Goal	read	`_id` [token]	subject.reference	US Core Goal Profile
	create	`_profile` [uri]	expressedBy.reference
	update	`patient` [reference]
	search-type
	patch
Group	read	`_id` [token]	member.entity.reference
	create	`_profile` [uri]
	update
	search-type
	patch
HealthcareService	read	`_id` [token]
	create	`_profile` [uri]
	update	`service-type` [token]
	search-type	chained parameters: `location.address-state` [string] `location.address-city` [string] `location.near` [special]
	patch
Immunization	read	`_id` [token]	patient.reference	US Core Immunization Profile
	create	`_profile` [uri]
	update	`patient` [reference]
	search-type
	patch
ImmunizationRecommendation	read	`_id` [token]	patient.reference
	create	`_profile` [uri]	supportingPatientInformation.reference
	update	`patient` [reference]
	search-type
	patch
Location	read	`_id` [token]		US Core Location Profile
	create	`_profile` [uri]
	update	`address` [string]
	search-type	`name` [string]
	patch	`name` [string]
Measure	read	`_id` [token]
	create	`_profile` [uri]
	update
	search-type
	patch
Medication	read	`_id` [token]		US Core Medication Profile
	create	`_profile` [uri]
	update
	search-type
	patch
MedicationAdministration	read	`_id` [token]	subject.reference
	create	`_profile` [uri]	supportingInformation.reference
	update	`patient` [reference]	performer.actor.reference
	search-type
	patch
MedicationDispense	read	`_id` [token]	subject.reference
	create	`_profile` [uri]	supportingInformation.reference
	update	`patient` [reference]	performer.actor.reference
	search-type		receiver.reference
	patch		receiver.reference
MedicationRequest	read	`_id` [token]	subject.reference	US Core MedicationRequest Profile
	create	`_profile` [uri]	requester.reference
	update	`patient` [reference]	performer.reference
	search-type	`intent` [token]	reportedReference.reference
	patch	`status` [token]	supportingInformation.reference
MedicationStatement	read	`_id` [token]	subject.reference
	create	`_profile` [uri]	informationSource.reference
	update	`patient` [reference]
	search-type
	patch
NutritionOrder	read	`_id` [token]	patient.reference
	create	`_profile` [uri]
	update	`patient` [reference]
	search-type
	patch
Observation	read	`_id` [token]	subject.reference	US Core Smoking Status Profile
	create	`_profile` [uri]	performer.reference
	update	`patient` [reference]
	search-type	`code` [token]
	patch	`category` [token]
	patch	`encounter` [reference]
OperationDefinition	read	`_id` [token]
	create	`_profile` [uri]
	update
	search-type
	patch
Organization	read	`_id` [token]		US Core Organization Profile
	create	`_profile` [uri]
	update	`address` [string]
	search-type	`name` [string]
	patch	`name` [string]
OrganizationAffiliation	read	`_id` [token]
	create	`_profile` [uri]
	update	`network` [reference]
	search-type
	patch
Patient	read	`_id` [token]	managingOrganization.reference	US Core Patient Profile
	create	`_profile` [uri]	generalPractitioner.reference
	update	`address` [string]	contact.organization.reference
	search-type	`birthdate` [date]	link.other.reference
	patch	`family` [string]
		`gender` [token]
		`given` [string]
		`identifier` [token]
		`name` [string]
PlanDefinition	read	`_id` [token]
	create	`_profile` [uri]
	update
	search-type
	patch
Practitioner	read	`_id` [token]		US Core Practitioner Profile
	create	`_profile` [uri]
	update	`identifier` [token]
	search-type	`name` [string]
	patch	`address-state` [string]
		`qualification-period` [date]
		`qualification-wherevalid-code`[token]
PractitionerRole	read	`_id` [token]		US Core PractitionerRole Profile
	create	`_profile` [uri]
	update	`practitioner` [reference]
	search-type	`specialty` [token]
	patch	chained parameters: `practitioner.identifier` [token], `practitioner.name` [string]
	patch	`network` [reference]
Procedure	read	`_id` [token]	subject.reference	US Core Procedure Profile
	create	`_profile` [uri]	recorder.reference
	update	`patient` [reference]	asserter.referrence
	search-type	`date` [date]	performer.actor.reference
	patch	`date` [date]	performer.actor.reference
Provenance	read	`_id` [token]	target.reference	US Core Provenance Profile
	create	`_profile` [uri]	agent.who.reference
	update	`patient` [reference]	agent.onBehalfOf.reference
	search-type		entity.what.reference
	patch		entity.what.reference
Questionnaire	read	`_id` [token]	enableWhen.answerReference.reference
	create	`_profile` [uri]	answerOption.valueReference.reference
	update		initial.valueReference.reference
	search-type
	patch
RelatedPerson	read	`_id` [token]	patient.reference
	create	`_profile` [uri]
	update	`patient` [reference]
	search-type
	patch
RequestGroup	read	`_id` [token]	subject.reference
	create	`_profile` [uri]	action.participant.reference
	update	`patient` [reference]	action.action.participant.reference
	search-type
	patch
RiskAssessment	read	`_id` [token]	basedOn.reference
	create	`_profile` [uri]	parent.reference
	update	`patient` [reference]	subject.reference
	search-type		basis.reference
	patch		basis.reference
ServiceRequest	read	`_id` [token]	subject.reference
	create	`_profile` [uri]	requester.reference
	update	`patient` [reference]	performer.reference
	search-type
	patch
Substance	read	`_id` [token]
	create	`_profile` [uri]
	update
	search-type
	patch
Task	read	`_id` [token]	basedOn.reference
	create	`_profile` [uri]	focus.reference
	update	`patient` [reference]	for.reference
	search-type		requester.reference
	patch		owner.reference
	patch		restriction.recipient.reference
VisionPrescription	read	`_id` [token]	patient.reference
	create	`_profile` [uri]
	update	`patient` [reference]
	search-type
	patch