US Core IG support reference

This page explains US Core support for zen-lang validation mode.

Since the 2405 release, using Aidbox in FHIR schema validation engine is recommended, which is incompatible with zen or Entity/Attribute options.

Setup Aidbox with FHIR Schema validation engine

Supported versions

Currently supported version is 5.0.1. It is available via this URL: https://github.com/zen-fhir/hl7-fhir-us-core.git.

Historical versions 2.1.0, 3.0.0, 3.0.1, 3.1.0, 3.1.1, 3.2.0, 4.0.0, 4.1.0 and 5.0.0 support is a work in progress. You can try them out by enabling via zip URL. List of URLs is available here.

Supported artifacts

Profiles

When a profile is loaded into Aidbox it can be used for validation via meta.profile attribute of resources.

Profile	Support	Notes
AllergyIntolerance	Supported
CarePlan	Supported
CareTeam	Supported
Condition Encounter Diagnosis	Supported
Condition Problems and Health Concerns	Supported
Implantable Device	Supported
DiagnosticReport for Laboratory Results Reporting	Supported
DiagnosticReport for Report and Note Exchange	Supported
DocumentReference	Supported
Encounter	Supported
Goal	Supported
Immunization	Supported
Location	Supported
Medication	Supported
MedicationRequest	Supported
Observation Clinical Test Result	Supported
Observation Imaging Result	Supported
Laboratory Result Observation	Supported
Observation Sexual Orientation	Supported
Observation Social History	Supported
Observation Survey	Supported
Observation SDOH Assessment	Supported
Smoking Status Observation	Supported
Vital Signs	Supported
Pediatric Head Occipital-frontal Circumference Percentile	Supported
Blood Pressure	Supported
BMI	Supported
Body Height	Supported
Body Temperature	Supported
Body Weight	Supported
Head Circumference	Supported
Heart Rate	Supported
Pediatric BMI for Age Observation	Supported
Pediatric Weight for Height Observation	Supported
Pulse Oximetry	Supported
Respiratory Rate	Supported
Organization	Supported
Patient	Supported
Practitioner	Supported
PractitionerRole	Supported
Procedure	Supported
Provenance	Supported
QuestionnaireResponse	Supported
RelatedPerson	Supported
ServiceRequest	Supported

Extensions

Enabling extensions allows Aidbox to validate its rules and constraints on a resource validation. If an extension is not enabled it still can be used in a resource, but no validation will be applied to it.

Extension	Support	First-class attribute
Birth Sex	Supported	Patient.birthsex
Direct email	Supported	none
Ethnicity	Supported	Patient.ethnicity
Questionnaire URI	Supported	QuestionnaireResponse._questionnaire.url
Gender Identity	Supported	Patient.genderIdentity
Race	Supported	Patient.race

Terminology

Loading a terminology into Aidbox allows you to use Terminology API and also to validate value set bindings in resources. If a terminology is not loaded you can still save resources, but no validation of the terminology bindings will be applied.

Value Sets

ValueSet	Support	Notes
Birth Sex	Supported
Detailed ethnicity	Supported
Detailed Race	Supported
Language codes with language and optionally a region modifier	Partially supported	Relies on code system BCP-47 with grammar. Expressions are not supported, only a subset of codes can be validated.
US Core Narrative Status	Supported
OMB Ethnicity Categories	Supported
OMB Race Categories	Supported
US Core Clinical Note Type	Supported
US Core Clinical Test Codes	Supported
US Core Common SDOH Assessments	Supported
US Core Condition Codes	Partially supported	ICD-10 and ICD-9 codes are included. SNOMED CT US codes are planned to be supported.
US Core Diagnostic Report Category Codes	Supported
US Core Diagnostic Report Laboratory Codes	Not supported	Relies on externally published code system LOINC. Planned to be supported.
US Core Discharge Disposition	Not supported	Relies on externally published code system http://www.nubc.org/patient-discharge
US Core DocumentReference Category	Supported
US Core DocumentReference Type	Partially supported	Relies on externally published code system LOINC. Planned to be supported.
US Core Encounter Type	Partially supported	CPT codes are included. SNOMED CT US codes are planned to be supported.
US Core Goal Codes	Partially supported	Includes whole SNOMED CT and LOINC terminologies. Both are externally published and are planned to be supported.
US Core Non Laboratory Codes	Not supported	Relies on externally published code system LOINC. Planned to be supported.
US Core Observation Category	Supported
US Core Status for Smoking Status Observation	Supported
US Core Observation Value Codes (SNOMED-CT)	Partially supported	Includes whole SNOMED CT. Planned to be supported.
US Core Problem or Health Concern	Supported
US Core Procedure Codes	Partially supported	Relies on externally published code systems SNOMED CT US/LOINC/CPT/CDT.
US Core Provenance Participant Type Codes	Supported
US Core Provider Role (NUCC)	Supported	Includes NUCC codes provided here.
US Core ServiceRequest Category Codes	Supported
US Core Sexual Orientation	Supported
US Core Smoking Status Observation Codes	Supported
US Core Smoking Status Max-Binding	Partially supported	Includes whole SNOMED CT. Planned to be supported.
US Core Survey Codes	Not supported	Relies on externally published code system LOINC. Planned to be supported.
US Core Tags ValueSet	Supported
US Core Vital Signs ValueSet	Supported
USPS Two Letter Alphabetic Codes	Not supported	Relies on externally published code system https://www.usps.com/.

Code Systems

CodeSystem	Support	Notes
US Core CarePlan Category Extension Codes	Not supported	Planned to be supported.
US Core Condition Category Extension Codes	Supported
US Core DocumentReferences Category Codes	Supported
US Core Observation Category Extension Codes	Supported
US Core Provenance Participant Type Extension Codes	Supported
US Core Tags CodeSystem	Supported

Externally Published code systems

ValueSet	Support	Notes
http://www.cms.gov/Medicare/Coding/ICD10	Supported	Refer to the ICD 10 import guide
http://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets	Not supported
http://www.ada.org/cdt	Not supported
https://www.usps.com	Not supported

Search Parameters

Loading Search Parameters into Aidbox enables you to use them in Search API.

Resource type	Parameter	Support	Notes
CareTeam	role	Supported
Condition	asserted-date	Supported	Since 2301
Encounter	discharge-disposition	Supported
Goal	description	Supported
Patient	race	Supported	Since 2301
Patient	ethnicity	Supported	Since 2301
Patient	gender-identity	Supported	Since 2301

US Core IG also contains Search Parameters derived from the Base FHIR Specification, they all are fully supported.

Resource type	Parameters
AllergyIntolerance	clinical-status, patient
CarePlan	category, date, patient, status
CareTeam	patient, status, role
Condition	category, clinical-status, patient, onset-date, asserted-date, recorded-date, abatement-date, code, encounter
Device	patient, type
DiagnosticReport	status, patient, category, code, date
DocumentReference	_id, status, patient, category, type, date, period
Encounter	_id, class, date, identifier, patient, location, status, type, discharge-disposition
Goal	lifecycle-status, patient, target-date
Immunization	patient, status, date
Location	name, address, address-city, address-state, address-postalcode
MedicationRequest	status, intent, patient, encounter, authoredon
Observation	status, category, code, date, patient
Organization	name, address
Patient	_id, birthdate, family, gender, given, identifier, name
Practitioner	_id, name, identifier
PractitionerRole	specialty, practitioner
Procedure	status, patient, date, code
QuestionnaireResponse	_id, patient, status, _tag, authored, questionnaire
RelatedPerson	_id, patient
ServiceRequest	status, patient, category, code, authored, _id

Operations

Various REST API operations described in an IG.

Operation	Support
Fetch DocumentReference	Not supported

Capability Statements

Supporting a CapabilityStatement allows to perform FHIR server capabilities discovery.

Capability Statement	Support	Notes
Server CapabilityStatement	Partially supported	Aidbox instance generates Capability Statement based on its current set up. Generated response may differ from the IG statement.
Client CapabilityStatement	Not supported	This is related to FHIR clients, not FHIR servers.