US Core IG support reference
This reference is a work in progress. Please, contact us if have any questions.
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
Please, contact us if you want to use some of IG functions that are not currently supported.
Profiles
When a profile is loaded into Aidbox it can be used for validation via meta.profile attribute of resources.
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.
Patient.birthsex
none
Patient.ethnicity
QuestionnaireResponse._questionnaire.url
Patient.genderIdentity
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
ICD-10 and ICD-9 codes are included. SNOMED CT US codes are planned to be supported.
Relies on externally published code system LOINC. Planned to be supported.
Relies on externally published code system LOINC. Planned to be supported.
CPT codes are included. SNOMED CT US codes are planned to be supported.
Includes whole SNOMED CT and LOINC terminologies. Both are externally published and are planned to be supported.
Relies on externally published code system LOINC. Planned to be supported.
Includes whole SNOMED CT. Planned to be supported.
Relies on externally published code systems SNOMED CT US/LOINC/CPT/CDT.
Includes whole SNOMED CT. Planned to be supported.
Relies on externally published code system LOINC. Planned to be supported.
Relies on externally published code system https://www.usps.com/.
Code Systems
Planned to be supported.
Externally Published code systems
http://www.cms.gov/Medicare/Coding/ICD10
http://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets
http://www.ada.org/cdt
https://www.usps.com
Search Parameters
Loading Search Parameters into Aidbox enables you to use them in Search API.
CareTeam
role
Condition
asserted-date
Since 2301
Encounter
discharge-disposition
Goal
description
Patient
race
Since 2301
Patient
ethnicity
Since 2301
Patient
gender-identity
Since 2301
US Core IG also contains Search Parameters derived from the Base FHIR Specification, they all are fully supported.
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.
Capability Statements
Supporting a CapabilityStatement allows to perform FHIR server capabilities discovery.
This is related to FHIR clients, not FHIR servers.
Last updated
Was this helpful?