US Core Implementation Guide
9.0.0 - CI Build United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 9.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Table of Contents

Page standards status: Informative
.. 0 Table of Contents
... 1 Home
... 2 Conformance
.... 2.1 General Requirements
.... 2.2 Must Support
..... 2.2.1 Observation Summary Table
.... 2.3 SMART on FHIR Obligations and Capabilities
.... 2.4 Security
.... 2.5 Requirements Table
... 3 Guidance
.... 3.1 USCDI
.... 3.2 General Guidance
.... 3.3 Clinical Notes
.... 3.4 Medication List
.... 3.5 Basic Provenance
..... 3.5.1 Using Provenance To Target Resource Elements
.... 3.6 Screening and Assessments
.... 3.7 Relationship With Other IGs
... 4 Profiles and Extensions
... 5 Capability Statements and Requirements Resources
... 6 Search Parameters and Operations
... 7 Terminology
.... 7.1 VSAC to FHIR Code System Mapping Table
... 8 Examples
... 9 Downloads
... 10 Version History
.... 10.1 Change Log
.... 10.2 Changes Between Versions
... 11 Looking Ahead
.... 11.1 US Core Roadmap
.... 11.2 Writing Vital Signs
.... 11.3 Writing Clinical Notes
.... 11.4 Patient Data Feed
..... 11.4.1 Patient Data Feed Additional Resources
... 12 US Core ImplementationGuide Resource
... 13 Artifacts Summary
.... 13.1 US Core Certifying System Requirements
.... 13.2 US Core Client Requirements
.... 13.3 US Core Server Requirements
.... 13.4 US Core Client CapabilityStatement
.... 13.5 US Core Server CapabilityStatement
.... 13.6 US Core Fetch DocumentReference
.... 13.7 USCoreAllergyintoleranceClinicalStatus
.... 13.8 USCoreAllergyintolerancePatient
.... 13.9 USCoreCareplanCategory
.... 13.10 USCoreCareplanDate
.... 13.11 USCoreCareplanPatient
.... 13.12 USCoreCareplanStatus
.... 13.13 USCoreCareteamPatient
.... 13.14 USCoreCareTeamRole
.... 13.15 USCoreCareteamStatus
.... 13.16 USCoreConditionAbatementDate
.... 13.17 USCoreConditionAssertedDate
.... 13.18 USCoreConditionCategory
.... 13.19 USCoreConditionClinicalStatus
.... 13.20 USCoreConditionCode
.... 13.21 USCoreConditionEncounter
.... 13.22 USCoreConditionLastUpdated
.... 13.23 USCoreConditionOnsetDate
.... 13.24 USCoreConditionPatient
.... 13.25 USCoreConditionRecordedDate
.... 13.26 USCoreCoveragePatient
.... 13.27 USCoreDevicePatient
.... 13.28 USCoreDeviceStatus
.... 13.29 USCoreDeviceType
.... 13.30 USCoreDiagnosticreportCategory
.... 13.31 USCoreDiagnosticreportCode
.... 13.32 USCoreDiagnosticreportDate
.... 13.33 USCoreDiagnosticreportLastUpdated
.... 13.34 USCoreDiagnosticreportPatient
.... 13.35 USCoreDiagnosticreportStatus
.... 13.36 USCoreDocumentreferenceCategory
.... 13.37 USCoreDocumentreferenceDate
.... 13.38 USCoreDocumentreferenceId
.... 13.39 USCoreDocumentreferencePatient
.... 13.40 USCoreDocumentreferencePeriod
.... 13.41 USCoreDocumentreferenceStatus
.... 13.42 USCoreDocumentreferenceType
.... 13.43 USCoreEncounterClass
.... 13.44 USCoreEncounterDate
.... 13.45 USCoreEncounterDischargeDisposition
.... 13.46 USCoreEncounterId
.... 13.47 USCoreEncounterIdentifier
.... 13.48 USCoreEncounterLastUpdated
.... 13.49 USCoreEncounterLocation
.... 13.50 USCoreEncounterPatient
.... 13.51 USCoreEncounterStatus
.... 13.52 USCoreEncounterType
.... 13.53 USCoreEthnicity
.... 13.54 USCoreFamilymemberhistoryCode
.... 13.55 USCoreFamilymemberhistoryPatient
.... 13.56 USCoreGoalDescription
.... 13.57 USCoreGoalLifecycleStatus
.... 13.58 USCoreGoalPatient
.... 13.59 USCoreGoalTargetDate
.... 13.60 USCoreImmunizationDate
.... 13.61 USCoreImmunizationPatient
.... 13.62 USCoreImmunizationStatus
.... 13.63 USCoreLocationAddress
.... 13.64 USCoreLocationAddressCity
.... 13.65 USCoreLocationAddressPostalcode
.... 13.66 USCoreLocationAddressState
.... 13.67 USCoreLocationName
.... 13.68 USCoreMedicationdispensePatient
.... 13.69 USCoreMedicationdispenseStatus
.... 13.70 USCoreMedicationdispenseType
.... 13.71 USCoreMedicationrequestAuthoredon
.... 13.72 USCoreMedicationrequestEncounter
.... 13.73 USCoreMedicationrequestIntent
.... 13.74 USCoreMedicationrequestPatient
.... 13.75 USCoreMedicationrequestStatus
.... 13.76 USCoreObservationCategory
.... 13.77 USCoreObservationCode
.... 13.78 USCoreObservationDate
.... 13.79 USCoreObservationLastUpdated
.... 13.80 USCoreObservationPatient
.... 13.81 USCoreObservationStatus
.... 13.82 USCoreOrganizationAddress
.... 13.83 USCoreOrganizationName
.... 13.84 USCorePatientBirthdate
.... 13.85 USCorePatientDeathDate
.... 13.86 USCorePatientFamily
.... 13.87 USCorePatientGiven
.... 13.88 USCorePatientId
.... 13.89 USCorePatientIdentifier
.... 13.90 USCorePatientName
.... 13.91 USCorePractitionerId
.... 13.92 USCorePractitionerIdentifier
.... 13.93 USCorePractitionerName
.... 13.94 USCorePractitionerrolePractitioner
.... 13.95 USCorePractitionerroleSpecialty
.... 13.96 USCoreProcedureCode
.... 13.97 USCoreProcedureDate
.... 13.98 USCoreProcedurePatient
.... 13.99 USCoreProcedureStatus
.... 13.100 USCoreQuestionnaireresponseAuthored
.... 13.101 USCoreQuestionnaireresponseId
.... 13.102 USCoreQuestionnaireresponsePatient
.... 13.103 USCoreQuestionnaireresponseQuestionnaire
.... 13.104 USCoreQuestionnaireresponseStatus
.... 13.105 USCoreRace
.... 13.106 USCoreRelatedpersonId
.... 13.107 USCoreRelatedpersonName
.... 13.108 USCoreRelatedpersonPatient
.... 13.109 USCoreServicerequestAuthored
.... 13.110 USCoreServicerequestCategory
.... 13.111 USCoreServicerequestCode
.... 13.112 USCoreServicerequestId
.... 13.113 USCoreServicerequestPatient
.... 13.114 USCoreServicerequestStatus
.... 13.115 USCoreSpecimenId
.... 13.116 USCoreSpecimenPatient
.... 13.117 US Core ADI DocumentReference Profile
.... 13.118 US Core AllergyIntolerance Profile
.... 13.119 US Core Average Blood Pressure Profile
.... 13.120 US Core Blood Pressure Profile
.... 13.121 US Core BMI Profile
.... 13.122 US Core Body Height Profile
.... 13.123 US Core Body Temperature Profile
.... 13.124 US Core Body Weight Profile
.... 13.125 US Core Care Experience Preference Profile
.... 13.126 US Core CarePlan Profile
.... 13.127 US Core CareTeam Profile
.... 13.128 US Core Condition Encounter Diagnosis Profile
.... 13.129 US Core Condition Problems and Health Concerns Profile
.... 13.130 US Core Coverage Profile
.... 13.131 US Core Device Profile
.... 13.132 US Core DiagnosticReport Profile for Laboratory Results Reporting
.... 13.133 US Core DiagnosticReport Profile for Report and Note Exchange
.... 13.134 US Core DocumentReference Profile
.... 13.135 US Core Encounter Profile
.... 13.136 US Core FamilyMemberHistory Profile
.... 13.137 US Core Goal Profile
.... 13.138 US Core Head Circumference Profile
.... 13.139 US Core Heart Rate Profile
.... 13.140 US Core Immunization Profile
.... 13.141 US Core Laboratory Result Observation Profile
.... 13.142 US Core Location Profile
.... 13.143 US Core Medication Profile
.... 13.144 US Core MedicationDispense Profile
.... 13.145 US Core MedicationRequest Profile
.... 13.146 US Core Observation ADI Documentation Profile
.... 13.147 US Core Observation Clinical Result Profile
.... 13.148 US Core Observation Occupation Profile
.... 13.149 US Core Observation Pregnancy Intent Profile
.... 13.150 US Core Observation Pregnancy Status Profile
.... 13.151 US Core Observation Screening Assessment Profile
.... 13.152 US Core Observation Sexual Orientation Profile
.... 13.153 US Core Organization Profile
.... 13.154 US Core Patient Profile
.... 13.155 US Core Pediatric BMI for Age Observation Profile
.... 13.156 US Core Pediatric Head Occipital Frontal Circumference Percentile Profile
.... 13.157 US Core Pediatric Weight for Height Observation Profile
.... 13.158 US Core Practitioner Profile
.... 13.159 US Core PractitionerRole Profile
.... 13.160 US Core Procedure Profile
.... 13.161 US Core Provenance Profile
.... 13.162 US Core Pulse Oximetry Profile
.... 13.163 US Core QuestionnaireResponse Profile
.... 13.164 US Core RelatedPerson Profile
.... 13.165 US Core Respiratory Rate Profile
.... 13.166 US Core ServiceRequest Profile
.... 13.167 US Core Simple Observation Profile
.... 13.168 US Core Smoking Status Observation Profile
.... 13.169 US Core Specimen Profile
.... 13.170 US Core Treatment Intervention Preference Profile
.... 13.171 US Core Vital Signs Profile
.... 13.172 US Core Authentication Time Extension
.... 13.173 US Core Birth Sex Extension
.... 13.174 US Core Direct email Extension
.... 13.175 US Core Ethnicity Extension
.... 13.176 US Core Extension Questionnaire URI
.... 13.177 US Core FamilyMemberHistory Recorder Extension
.... 13.178 US Core Gender Identity Extension
.... 13.179 US Core Individual Sex Extension
.... 13.180 US Core Interpreter Needed Extension
.... 13.181 US Core Jurisdiction Extension
.... 13.182 US Core Medication Adherence Extension
.... 13.183 US Core Race Extension
.... 13.184 US Core Sex Extension
.... 13.185 US Core Tribal Affiliation Extension
.... 13.186 US Core USCDI Requirement Extension
.... 13.187 US Core Clinical Note Type
.... 13.188 US Core Clinical Result Observation Category
.... 13.189 US Core Condition Codes
.... 13.190 US Core Condition Codes Current
.... 13.191 US Core Diagnostic Report Category Codes
.... 13.192 US Core DocumentReference Category
.... 13.193 US Core DocumentReference Type
.... 13.194 US Core Goal Codes
.... 13.195 US Core Laboratory Test Codes
.... 13.196 US Core Narrative Status
.... 13.197 US Core Non Laboratory Codes
.... 13.198 US Core Problem or Health Concern
.... 13.199 US Core Procedure Codes
.... 13.200 US Core Screening Assessment Condition Category
.... 13.201 US Core Screening Assessment Observation Category
.... 13.202 US Core Screening Assessment Observation Maximum Category
.... 13.203 US Core ServiceRequest Category Codes
.... 13.204 US Core Simple Observation Category
.... 13.205 US Core Specimen Condition
.... 13.206 US Core Status for Smoking Status Observation
.... 13.207 US Core CarePlan Category Extension Codes
.... 13.208 US Core Category
.... 13.209 US Core Condition Category Extension Codes
.... 13.210 US Core DocumentReferences Category Codes
.... 13.211 10 minute Apgar Color Example
.... 13.212 10 minute Apgar Heart Rate Example
.... 13.213 10 minute Apgar Muscle Tone Example
.... 13.214 10 minute Apgar Reflex Irritability Example
.... 13.215 10 minute Apgar Respiratory effort Example
.... 13.216 10 Minute Apgar Score Example
.... 13.217 10 Minute Apgar Score Panel Example
.... 13.218 ADI Observation Presence ADI Example
.... 13.219 ADI Observation Presence No ADI Example
.... 13.220 Ahc-Hrsn Item Observation Example 68517-2
.... 13.221 Alcohol Use Disorder Identification Test - Consumption (AUDIT-C) Questionnaire Example
.... 13.222 Alcohol Use Disorder Identification Test - Consumption (AUDIT-C) QuestionnaireResponse Example
.... 13.223 Alcohol Use Status Example
.... 13.224 Alcoholic Drinks Per Day Example
.... 13.225 AllergyIntolerance Example
.... 13.226 AllergyIntolerance Non-pharmacologic Agent Example
.... 13.227 AllergyIntolerance Provenance Example 1
.... 13.228 AllergyIntolerance Provenance Example 2
.... 13.229 At Home In Vitro Test Example
.... 13.230 Audit-C Item Example 68517-2
.... 13.231 Audit-C Item Example 68519-8
.... 13.232 Audit-C Item Example 68520-6
.... 13.233 Audit-C Item Example 75626-2
.... 13.234 Audit-C Panel Example 72109-2
.... 13.235 Average Blood Pressure Example
.... 13.236 Basic Metabolic Panel Example
.... 13.237 Blood Pressure Example
.... 13.238 BMI Example
.... 13.239 BP Data Absent Example
.... 13.240 Capillary refill Time Nail Bed Example
.... 13.241 Care Experience Preference Example
.... 13.242 CarePlan Ulcer Example
.... 13.243 CareTeam Example
.... 13.244 CBC Example
.... 13.245 Chest Xray Example
.... 13.246 Cigarette Pack-Years Example
.... 13.247 Colonoscopy Example
.... 13.248 Condition Duodenal Resolved Ulcer Example
.... 13.249 Condition Duodenal Ulcer Example
.... 13.250 Coverage Example
.... 13.251 Deceased Patient Example
.... 13.252 Defibrillator Device Example
.... 13.253 Device Infusion Pump Example
.... 13.254 Device Walker Example
.... 13.255 DiagnosticReport Cardiology Report Example
.... 13.256 DiagnosticReport Chest Xray Report Example
.... 13.257 Discharge Summary Example
.... 13.258 Docref Example 1
.... 13.259 Docref Example 2
.... 13.260 DocumentReference DNR
.... 13.261 DocumentReference Living Will
.... 13.262 DocumentReference POLST (PDF)
.... 13.263 DXA Bone density quantitative measurement panel Example
.... 13.264 DXA Femur-L ArMass BMD Example
.... 13.265 DXA Femur-L T-score BMD Example
.... 13.266 DXA Femur-L Z-score BMD Example
.... 13.267 DXA Hip-L ArMass BMD Example
.... 13.268 DXA Hip-L T-score BMD Example
.... 13.269 DXA Hip-L Z-score BMD Example
.... 13.270 EKG impression Example
.... 13.271 EKG lead Example
.... 13.272 EKG Strip Image
.... 13.273 Electronic Cigarette User Example
.... 13.274 Encounter 1 Example
.... 13.275 Encounter 1036 Example
.... 13.276 Encounter Delivery Example
.... 13.277 Encounter Diagnosis Example 1
.... 13.278 Encounter Diagnosis Example 2
.... 13.279 Episode Summary Example
.... 13.280 Erythrocytes Example
.... 13.281 Evs Item Example 68516-4
.... 13.282 Evs Item Example 89555-7
.... 13.283 Evs Panel Example 89574-8
.... 13.284 Exercise Per Day Example
.... 13.285 Exercise Per Week Example
.... 13.286 Exercise Vital Sign Questionnaire Example
.... 13.287 Exercise Vital Sign QuestionnaireResponse Example
.... 13.288 FamilyMemberHistory Example
.... 13.289 Goal 1 Example
.... 13.290 Goal 2 Example
.... 13.291 Head Circumference Example
.... 13.292 Health Concern Example
.... 13.293 Heart Rate Example
.... 13.294 Heart rate rhythm Example
.... 13.295 Height Example
.... 13.296 Hematocrit Example
.... 13.297 Hemoglobin Example
.... 13.298 HL7East Example
.... 13.299 Hospital Location
.... 13.300 HVS Item Example 88122-7
.... 13.301 HVS Item Example 88123-5
.... 13.302 HVS Item Example 88124-3
.... 13.303 HVSPanel Example 88121-9
.... 13.304 Immunization Example 1
.... 13.305 Jugular vein distension Example
.... 13.306 Length Example
.... 13.307 Leukocytes Example
.... 13.308 Lipemic Serum Specimen Example
.... 13.309 MCH Example
.... 13.310 MCHC Example
.... 13.311 MCV Example
.... 13.312 Medication Dispense Example
.... 13.313 MedicationRequest Coded Oral Axid Example
.... 13.314 MedicationRequest Contained Oral Axid Example
.... 13.315 MedicationRequest Referenced Oral Axid Example
.... 13.316 MedicationRequest Self Tylenol Example
.... 13.317 Missing Coded Data Example
.... 13.318 Observation SatO2 FiO2 Example
.... 13.319 Occupation Observation Example
.... 13.320 Occupation Observation Example: Industry Unknown
.... 13.321 Occupation Observation Example: Unknown Occupation
.... 13.322 OFC Percentile Example
.... 13.323 Organization 2 Example
.... 13.324 Organization Acme Lab Example
.... 13.325 Organization Acme Payer Example
.... 13.326 Organization Holy Healthcare Example
.... 13.327 Oxygen Saturation Example
.... 13.328 P-R interval {EKG lead} Example
.... 13.329 Patient Child Example
.... 13.330 Patient Example
.... 13.331 Patient Infant Example
.... 13.332 Patient Niece Example
.... 13.333 Pediatric BMI Example
.... 13.334 Pediatric Wt Example
.... 13.335 PHQ9 Item Example 44250-9
.... 13.336 PHQ9 Item Example 44251-7
.... 13.337 PHQ9 Item Example 44252-5
.... 13.338 PHQ9 Item Example 44253-3
.... 13.339 PHQ9 Item Example 44254-1
.... 13.340 PHQ9 Item Example 44255-8
.... 13.341 PHQ9 Item Example 44258-2
.... 13.342 PHQ9 Item Example 44259-0
.... 13.343 PHQ9 Item Example 44260-8
.... 13.344 PHQ9 Item Example 44261-6
.... 13.345 PHQ9 Item Example 69722-7
.... 13.346 PHQ9 Panel Example 44249-1
.... 13.347 Platelets Example
.... 13.348 Practitioner 1 Example
.... 13.349 Practitioner 2 Example
.... 13.350 Practitioner 3 Example
.... 13.351 Practitioner Pharmacist Example
.... 13.352 PractitionerRole_Practitioner_Endpoint_Bundle_Example Example
.... 13.353 Prapare Item Example 54899-0
.... 13.354 Prapare Item Example 56051-6
.... 13.355 Prapare Item Example 56799-0
.... 13.356 Prapare Item Example 63512-8
.... 13.357 Prapare Item Example 63586-2
.... 13.358 Prapare Item Example 67875-5
.... 13.359 Prapare Item Example 71802-3
.... 13.360 Prapare Item Example 76437-3
.... 13.361 Prapare Item Example 76501-6
.... 13.362 Prapare Item Example 82589-3
.... 13.363 Prapare Item Example 93026-3
.... 13.364 Prapare Item Example 93027-1
.... 13.365 Prapare Item Example 93028-9
.... 13.366 Prapare Item Example 93029-7
.... 13.367 Prapare Item Example 93030-5
.... 13.368 Prapare Item Example 93033-9
.... 13.369 Prapare Item Example 93034-7
.... 13.370 Prapare Item Example 93035-4
.... 13.371 Prapare Item Example 93038-8
.... 13.372 Prapare Multiselect-Item Example 32624-9-Answer0
.... 13.373 Prapare Multiselect-Item Example 32624-9-Answer1
.... 13.374 Prapare Multiselect-Item Example 93031-3-Answer0
.... 13.375 Prapare Multiselect-Item Example 93031-3-Answer1
.... 13.376 Prapare Panel Example 93025-5
.... 13.377 Prapare Panel Example 93039-6
.... 13.378 Prapare Panel Example 93040-4
.... 13.379 Prapare Panel Example 93041-2
.... 13.380 Prapare Panel Example 93042-0
.... 13.381 PRAPARE Panel Example 93043-8
.... 13.382 Pregnancy Intent Observation Example
.... 13.383 Pregnancy Status Observation Example
.... 13.384 Procedure Defibrillator Implant Example
.... 13.385 Prosthetic Knee Example
.... 13.386 Pulse intensity Palpation Example
.... 13.387 Q-T interval {EKG lead} Example
.... 13.388 QRS dur {EKG lead} Example
.... 13.389 Questionnaire Hunger Vital Sign (HVS) Example
.... 13.390 Questionnaire PHQ-9 Example
.... 13.391 Questionnaire PRAPARE Example
.... 13.392 QuestionnaireResponse Glascow Coma Score Example
.... 13.393 QuestionnaireResponse Hunger Vital Sign (HVS) Example
.... 13.394 QuestionnaireResponse PHQ-9 Example
.... 13.395 QuestionnaireResponse PRAPARE Example
.... 13.396 Rehab Example
.... 13.397 Respiratory Rate Example
.... 13.398 Saint Luke W Endpoint Example
.... 13.399 SDOH Problem/Health Concern Example
.... 13.400 Serum BUN Example
.... 13.401 Serum Calcium Example
.... 13.402 Serum Chloride Example
.... 13.403 Serum CO2 Example
.... 13.404 Serum Creatinine Example
.... 13.405 Serum Glucose Example
.... 13.406 Serum Potassium Example
.... 13.407 Serum Sodium Example
.... 13.408 Serum Specimen Example
.... 13.409 ServiceRequest BMP Example
.... 13.410 ServiceRequest CBC Example
.... 13.411 ServiceRequest Chest XRay Example
.... 13.412 ServiceRequest DNR Example
.... 13.413 ServiceRequest EKG Example
.... 13.414 ServiceRequest Food Pantry Referral Example
.... 13.415 ServiceRequest for Rehab Example
.... 13.416 Simple Observation Cognitive Status Example
.... 13.417 Simple Observation Disability Status Example
.... 13.418 Simple Observation Functional Status Example
.... 13.419 Simple Observation SDOH Example
.... 13.420 Some Day Smoker Example
.... 13.421 Substance Use Status Example
.... 13.422 Taps Item Example 75889-6
.... 13.423 Taps Item Example 88037-7
.... 13.424 Taps Item Example 96842-0
.... 13.425 Taps Item Example 96843-8
.... 13.426 Taps Item Example 96844-6
.... 13.427 Taps Panel Example 96841-2
.... 13.428 Temperature Example
.... 13.429 Tobacco, Alcohol, Prescription medications, and other Substance use screen (TAPS) Questionnaire Example
.... 13.430 Tobacco, Alcohol, Prescription medications, and other Substance use screen (TAPS) QuestionnaireResponse Example
.... 13.431 Treatment Intervention Preference Example
.... 13.432 Urine Specimen Example
.... 13.433 Urobilinogen Example
.... 13.434 US Core Version 3.1.1 Model Definition
.... 13.435 US Core Version 4.0.0 Model Definition
.... 13.436 US Core Version 5.0.1 Model Definition
.... 13.437 US Core Version 6.1.0 Model Definition
.... 13.438 US Core Version 7.0.0 Model Definition
.... 13.439 US Core Version 8.0.1 Model Definition
.... 13.440 US Core Version 9.0.0 Model Definition
.... 13.441 Uscore Med1 Example
.... 13.442 Uscore Med2 Example
.... 13.443 Weight Example
.... 13.444 Whole Blood Specimen Example
.... 13.445 Xray Chest Findings Example
.... 13.446 Xray Chest Impression Example