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.
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 |
---|---|---|
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
Supported | ||
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 |
---|---|---|
Supported |
| |
Supported | none | |
Supported |
| |
Supported |
| |
Supported |
| |
Supported |
|
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 |
---|---|---|
Supported | ||
Supported | ||
Supported | ||
Partially supported | Relies on code system BCP-47 with grammar. Expressions are not supported, only a subset of codes can be validated. | |
Supported | ||
Supported | ||
Supported |
| |
Supported |
| |
Supported |
| |
Supported |
| |
Partially supported | ICD-10 and ICD-9 codes are included. SNOMED CT US codes are planned to be supported. | |
Supported |
| |
Not supported | Relies on externally published code system LOINC. Planned to be supported. | |
Not supported | Relies on externally published code system http://www.nubc.org/patient-discharge | |
Supported |
| |
Partially supported | Relies on externally published code system LOINC. Planned to be supported. | |
Partially supported | CPT codes are included. SNOMED CT US codes are planned to be supported. | |
Partially supported | Includes whole SNOMED CT and LOINC terminologies. Both are externally published and are planned to be supported. | |
Not supported | Relies on externally published code system LOINC. Planned to be supported. | |
Supported |
| |
Supported |
| |
Partially supported | Includes whole SNOMED CT. Planned to be supported. | |
Supported |
| |
Partially supported | Relies on externally published code systems SNOMED CT US/LOINC/CPT/CDT. | |
Supported |
| |
Supported | Includes NUCC codes provided here. | |
Supported |
| |
Supported |
| |
Supported |
| |
Partially supported | Includes whole SNOMED CT. Planned to be supported. | |
Not supported | Relies on externally published code system LOINC. Planned to be supported. | |
Supported |
| |
Supported |
| |
Not supported | Relies on externally published code system |
Code Systems
CodeSystem | Support | Notes |
---|---|---|
Not supported | Planned to be supported. | |
Supported |
| |
Supported |
| |
Supported |
| |
Supported |
| |
Supported |
|
Externally Published code systems
ValueSet | Support | Notes |
---|---|---|
| Supported | Refer to the ICD 10 import guide |
| Not supported | |
| Not supported | |
| 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 |
---|---|
Not supported |
Capability Statements
Supporting a CapabilityStatement allows to perform FHIR server capabilities discovery.
Capability Statement | Support | Notes |
---|---|---|
Partially supported | Aidbox instance generates Capability Statement based on its current set up. Generated response may differ from the IG statement. | |
Not supported | This is related to FHIR clients, not FHIR servers. |
Last updated