US Core Implementation Guide
8.0.0 - STU 8 United States of America flag

This page is part of the US Core (v8.0.0: STU8) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions. Page versions: R8 R7 R6 R5 R4 R3

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
... 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 Changes Between Versions
.... 3.8 Relationship With Other IGs
... 4 Profiles and Extensions
... 5 Capability Statements
... 6 Search Parameters and Operations
... 7 Terminology
.... 7.1 VSAC to FHIR Code System Mapping Table
... 8 Security
... 9 Examples
... 10 Downloads
... 11 Change Log
... 12 Looking Ahead
.... 12.1 US Core Roadmap
.... 12.2 Writing Vital Signs
.... 12.3 Patient Data Feed
..... 12.3.1 Patient Data Feed Additional Resources
... 13 US Core ImplementationGuide Resource
... 14 Artifacts Summary
.... 14.1 US Core Client CapabilityStatement
.... 14.2 US Core Server CapabilityStatement
.... 14.3 US Core Fetch DocumentReference
.... 14.4 USCoreAllergyintoleranceClinicalStatus
.... 14.5 USCoreAllergyintolerancePatient
.... 14.6 USCoreCareplanCategory
.... 14.7 USCoreCareplanDate
.... 14.8 USCoreCareplanPatient
.... 14.9 USCoreCareplanStatus
.... 14.10 USCoreCareteamPatient
.... 14.11 USCoreCareTeamRole
.... 14.12 USCoreCareteamStatus
.... 14.13 USCoreConditionAbatementDate
.... 14.14 USCoreConditionAssertedDate
.... 14.15 USCoreConditionCategory
.... 14.16 USCoreConditionClinicalStatus
.... 14.17 USCoreConditionCode
.... 14.18 USCoreConditionEncounter
.... 14.19 USCoreConditionLastUpdated
.... 14.20 USCoreConditionOnsetDate
.... 14.21 USCoreConditionPatient
.... 14.22 USCoreConditionRecordedDate
.... 14.23 USCoreCoveragePatient
.... 14.24 USCoreDevicePatient
.... 14.25 USCoreDeviceStatus
.... 14.26 USCoreDeviceType
.... 14.27 USCoreDiagnosticreportCategory
.... 14.28 USCoreDiagnosticreportCode
.... 14.29 USCoreDiagnosticreportDate
.... 14.30 USCoreDiagnosticreportLastUpdated
.... 14.31 USCoreDiagnosticreportPatient
.... 14.32 USCoreDiagnosticreportStatus
.... 14.33 USCoreDocumentreferenceCategory
.... 14.34 USCoreDocumentreferenceDate
.... 14.35 USCoreDocumentreferenceId
.... 14.36 USCoreDocumentreferencePatient
.... 14.37 USCoreDocumentreferencePeriod
.... 14.38 USCoreDocumentreferenceStatus
.... 14.39 USCoreDocumentreferenceType
.... 14.40 USCoreEncounterClass
.... 14.41 USCoreEncounterDate
.... 14.42 USCoreEncounterDischargeDisposition
.... 14.43 USCoreEncounterId
.... 14.44 USCoreEncounterIdentifier
.... 14.45 USCoreEncounterLastUpdated
.... 14.46 USCoreEncounterLocation
.... 14.47 USCoreEncounterPatient
.... 14.48 USCoreEncounterStatus
.... 14.49 USCoreEncounterType
.... 14.50 USCoreEthnicity
.... 14.51 USCoreGoalDescription
.... 14.52 USCoreGoalLifecycleStatus
.... 14.53 USCoreGoalPatient
.... 14.54 USCoreGoalTargetDate
.... 14.55 USCoreImmunizationDate
.... 14.56 USCoreImmunizationPatient
.... 14.57 USCoreImmunizationStatus
.... 14.58 USCoreLocationAddress
.... 14.59 USCoreLocationAddressCity
.... 14.60 USCoreLocationAddressPostalcode
.... 14.61 USCoreLocationAddressState
.... 14.62 USCoreLocationName
.... 14.63 USCoreMedicationdispensePatient
.... 14.64 USCoreMedicationdispenseStatus
.... 14.65 USCoreMedicationdispenseType
.... 14.66 USCoreMedicationrequestAuthoredon
.... 14.67 USCoreMedicationrequestEncounter
.... 14.68 USCoreMedicationrequestIntent
.... 14.69 USCoreMedicationrequestPatient
.... 14.70 USCoreMedicationrequestStatus
.... 14.71 USCoreObservationCategory
.... 14.72 USCoreObservationCode
.... 14.73 USCoreObservationDate
.... 14.74 USCoreObservationLastUpdated
.... 14.75 USCoreObservationPatient
.... 14.76 USCoreObservationStatus
.... 14.77 USCoreOrganizationAddress
.... 14.78 USCoreOrganizationName
.... 14.79 USCorePatientBirthdate
.... 14.80 USCorePatientDeathDate
.... 14.81 USCorePatientFamily
.... 14.82 USCorePatientGiven
.... 14.83 USCorePatientId
.... 14.84 USCorePatientIdentifier
.... 14.85 USCorePatientName
.... 14.86 USCorePractitionerId
.... 14.87 USCorePractitionerIdentifier
.... 14.88 USCorePractitionerName
.... 14.89 USCorePractitionerrolePractitioner
.... 14.90 USCorePractitionerroleSpecialty
.... 14.91 USCoreProcedureCode
.... 14.92 USCoreProcedureDate
.... 14.93 USCoreProcedurePatient
.... 14.94 USCoreProcedureStatus
.... 14.95 USCoreQuestionnaireresponseAuthored
.... 14.96 USCoreQuestionnaireresponseId
.... 14.97 USCoreQuestionnaireresponsePatient
.... 14.98 USCoreQuestionnaireresponseQuestionnaire
.... 14.99 USCoreQuestionnaireresponseStatus
.... 14.100 USCoreRace
.... 14.101 USCoreRelatedpersonId
.... 14.102 USCoreRelatedpersonName
.... 14.103 USCoreRelatedpersonPatient
.... 14.104 USCoreServicerequestAuthored
.... 14.105 USCoreServicerequestCategory
.... 14.106 USCoreServicerequestCode
.... 14.107 USCoreServicerequestId
.... 14.108 USCoreServicerequestPatient
.... 14.109 USCoreServicerequestStatus
.... 14.110 USCoreSpecimenId
.... 14.111 USCoreSpecimenPatient
.... 14.112 US Core ADI DocumentReference Profile
.... 14.113 US Core AllergyIntolerance Profile
.... 14.114 US Core Average Blood Pressure Profile
.... 14.115 US Core Blood Pressure Profile
.... 14.116 US Core BMI Profile
.... 14.117 US Core Body Height Profile
.... 14.118 US Core Body Temperature Profile
.... 14.119 US Core Body Weight Profile
.... 14.120 US Core Care Experience Preference Profile
.... 14.121 US Core CarePlan Profile
.... 14.122 US Core CareTeam Profile
.... 14.123 US Core Condition Encounter Diagnosis Profile
.... 14.124 US Core Condition Problems and Health Concerns Profile
.... 14.125 US Core Coverage Profile
.... 14.126 US Core DiagnosticReport Profile for Laboratory Results Reporting
.... 14.127 US Core DiagnosticReport Profile for Report and Note Exchange
.... 14.128 US Core DocumentReference Profile
.... 14.129 US Core Encounter Profile
.... 14.130 US Core Goal Profile
.... 14.131 US Core Head Circumference Profile
.... 14.132 US Core Heart Rate Profile
.... 14.133 US Core Immunization Profile
.... 14.134 US Core Implantable Device Profile
.... 14.135 US Core Laboratory Result Observation Profile
.... 14.136 US Core Location Profile
.... 14.137 US Core Medication Profile
.... 14.138 US Core MedicationDispense Profile
.... 14.139 US Core MedicationRequest Profile
.... 14.140 US Core Observation ADI Documentation Profile
.... 14.141 US Core Observation Clinical Result Profile
.... 14.142 US Core Observation Occupation Profile
.... 14.143 US Core Observation Pregnancy Intent Profile
.... 14.144 US Core Observation Pregnancy Status Profile
.... 14.145 US Core Observation Screening Assessment Profile
.... 14.146 US Core Observation Sexual Orientation Profile
.... 14.147 US Core Organization Profile
.... 14.148 US Core Patient Profile
.... 14.149 US Core Pediatric BMI for Age Observation Profile
.... 14.150 US Core Pediatric Head Occipital Frontal Circumference Percentile Profile
.... 14.151 US Core Pediatric Weight for Height Observation Profile
.... 14.152 US Core Practitioner Profile
.... 14.153 US Core PractitionerRole Profile
.... 14.154 US Core Procedure Profile
.... 14.155 US Core Provenance Profile
.... 14.156 US Core Pulse Oximetry Profile
.... 14.157 US Core QuestionnaireResponse Profile
.... 14.158 US Core RelatedPerson Profile
.... 14.159 US Core Respiratory Rate Profile
.... 14.160 US Core ServiceRequest Profile
.... 14.161 US Core Simple Observation Profile
.... 14.162 US Core Smoking Status Observation Profile
.... 14.163 US Core Specimen Profile
.... 14.164 US Core Treatment Intervention Preference Profile
.... 14.165 US Core Vital Signs Profile
.... 14.166 US Core Authentication Time Extension
.... 14.167 US Core Birth Sex Extension
.... 14.168 US Core Direct email Extension
.... 14.169 US Core Ethnicity Extension
.... 14.170 US Core Extension Questionnaire URI
.... 14.171 US Core Gender Identity Extension
.... 14.172 US Core Interpreter Needed Extension
.... 14.173 US Core Jurisdiction Extension
.... 14.174 US Core Medication Adherence Extension
.... 14.175 US Core Race Extension
.... 14.176 US Core Sex Extension
.... 14.177 US Core Tribal Affiliation Extension
.... 14.178 US Core USCDI Requirement Extension
.... 14.179 US Core Clinical Note Type
.... 14.180 US Core Clinical Result Observation Category
.... 14.181 US Core Condition Codes
.... 14.182 US Core Condition Codes Current
.... 14.183 US Core Diagnostic Report Category Codes
.... 14.184 US Core DocumentReference Category
.... 14.185 US Core DocumentReference Type
.... 14.186 US Core Goal Codes
.... 14.187 US Core Laboratory Test Codes
.... 14.188 US Core Narrative Status
.... 14.189 US Core Non Laboratory Codes
.... 14.190 US Core Problem or Health Concern
.... 14.191 US Core Procedure Codes
.... 14.192 US Core Provenance Participant Type Codes
.... 14.193 US Core Screening Assessment Condition Category
.... 14.194 US Core Screening Assessment Observation Category
.... 14.195 US Core Screening Assessment Observation Maximum Category
.... 14.196 US Core ServiceRequest Category Codes
.... 14.197 US Core Simple Observation Category
.... 14.198 US Core Specimen Condition
.... 14.199 US Core Status for Smoking Status Observation
.... 14.200 US Core CarePlan Category Extension Codes
.... 14.201 US Core Category
.... 14.202 US Core Condition Category Extension Codes
.... 14.203 US Core DocumentReferences Category Codes
.... 14.204 US Core Provenance Participant Type Extension Codes
.... 14.205 10 minute Apgar Color Example
.... 14.206 10 minute Apgar Heart Rate Example
.... 14.207 10 minute Apgar Muscle Tone Example
.... 14.208 10 minute Apgar Reflex Irritability Example
.... 14.209 10 minute Apgar Respiratory effort Example
.... 14.210 10 Minute Apgar Score Example
.... 14.211 10 Minute Apgar Score Panel Example
.... 14.212 ADI Observation Presence ADI Example
.... 14.213 ADI Observation Presence No ADI Example
.... 14.214 Ahc-Hrsn Item Observation Example 68517-2
.... 14.215 Alcohol Use Disorder Identification Test - Consumption (AUDIT-C) Questionnaire Example
.... 14.216 Alcohol Use Disorder Identification Test - Consumption (AUDIT-C) QuestionnaireResponse Example
.... 14.217 Alcohol Use Status Example
.... 14.218 Alcoholic Drinks Per Day Example
.... 14.219 AllergyIntolerance Example
.... 14.220 AllergyIntolerance Non-pharmacologic Agent Example
.... 14.221 AllergyIntolerance Provenance Example 1
.... 14.222 AllergyIntolerance Provenance Example 2
.... 14.223 At Home In Vitro Test Example
.... 14.224 Audit-C Item Example 68517-2
.... 14.225 Audit-C Item Example 68519-8
.... 14.226 Audit-C Item Example 68520-6
.... 14.227 Audit-C Item Example 75626-2
.... 14.228 Audit-C Panel Example 72109-2
.... 14.229 Average Blood Pressure Example
.... 14.230 Basic Metabolic Panel Example
.... 14.231 Blood Pressure Example
.... 14.232 BMI Example
.... 14.233 BP Data Absent Example
.... 14.234 Capillary refill Time Nail Bed Example
.... 14.235 Care Experience Preference Example
.... 14.236 CareTeam Example
.... 14.237 CBC Example
.... 14.238 Chest Xray Example
.... 14.239 Cigarette Pack-Years Example
.... 14.240 Colonoscopy Example
.... 14.241 Condition Duodenal Ulcer Example
.... 14.242 Coverage Example
.... 14.243 Deceased Patient Example
.... 14.244 Device Defib Example
.... 14.245 Device Knee Example
.... 14.246 DiagnosticReport Cardiology Report Example
.... 14.247 DiagnosticReport Chest Xray Report Example
.... 14.248 Discharge Summary Example
.... 14.249 Docref Example 1
.... 14.250 Docref Example 2
.... 14.251 DocumentReference DNR
.... 14.252 DocumentReference Living Will
.... 14.253 DocumentReference POLST (PDF)
.... 14.254 DXA Bone density quantitative measurement panel Example
.... 14.255 DXA Femur-L ArMass BMD Example
.... 14.256 DXA Femur-L T-score BMD Example
.... 14.257 DXA Femur-L Z-score BMD Example
.... 14.258 DXA Hip-L ArMass BMD Example
.... 14.259 DXA Hip-L T-score BMD Example
.... 14.260 DXA Hip-L Z-score BMD Example
.... 14.261 EKG impression Example
.... 14.262 EKG lead Example
.... 14.263 EKG Strip Image
.... 14.264 Encounter 1 Example
.... 14.265 Encounter 1036 Example
.... 14.266 Encounter Delivery Example
.... 14.267 Encounter Diagnosis Example 1
.... 14.268 Encounter Diagnosis Example 2
.... 14.269 Episode Summary Example
.... 14.270 Erythrocytes Example
.... 14.271 Evs Item Example 68516-4
.... 14.272 Evs Item Example 89555-7
.... 14.273 Evs Panel Example 89574-8
.... 14.274 Exercise Per Day Example
.... 14.275 Exercise Per Week Example
.... 14.276 Exercise Vital Sign Questionnaire Example
.... 14.277 Exercise Vital Sign QuestionnaireResponse Example
.... 14.278 Goal 1 Example
.... 14.279 Goal 2 Example
.... 14.280 Head Circumference Example
.... 14.281 Health Concern Example
.... 14.282 Heart Rate Example
.... 14.283 Heart rate rhythm Example
.... 14.284 Height Example
.... 14.285 Hematocrit Example
.... 14.286 Hemoglobin Example
.... 14.287 HL7East Example
.... 14.288 Hospital Location
.... 14.289 HVS Item Example 88122-7
.... 14.290 HVS Item Example 88123-5
.... 14.291 HVS Item Example 88124-3
.... 14.292 HVSPanel Example 88121-9
.... 14.293 Immunization Example 1
.... 14.294 Jugular vein distension Example
.... 14.295 Length Example
.... 14.296 Leukocytes Example
.... 14.297 Lipemic Serum Specimen Example
.... 14.298 MCH Example
.... 14.299 MCHC Example
.... 14.300 MCV Example
.... 14.301 Medication Dispense Example
.... 14.302 MedicationRequest Coded Oral Axid Example
.... 14.303 MedicationRequest Contained Oral Axid Example
.... 14.304 MedicationRequest Referenced Oral Axid Example
.... 14.305 MedicationRequest Self Tylenol Example
.... 14.306 Missing Coded Data Example
.... 14.307 Observation SatO2 FiO2 Example
.... 14.308 Occupation Observation Example
.... 14.309 Occupation Observation Example: Industry Unknown
.... 14.310 Occupation Observation Example: Unknown Occupation
.... 14.311 OFC Percentile Example
.... 14.312 Organization 2 Example
.... 14.313 Organization Acme Lab Example
.... 14.314 Organization Acme Payer Example
.... 14.315 Organization Holy Healthcare Example
.... 14.316 Oxygen Saturation Example
.... 14.317 P-R interval {EKG lead} Example
.... 14.318 Patient Child Example
.... 14.319 Patient Example
.... 14.320 Patient Infant Example
.... 14.321 Patient Niece Example
.... 14.322 Pediatric BMI Example
.... 14.323 Pediatric Wt Example
.... 14.324 PHQ9 Item Example 44250-9
.... 14.325 PHQ9 Item Example 44251-7
.... 14.326 PHQ9 Item Example 44252-5
.... 14.327 PHQ9 Item Example 44253-3
.... 14.328 PHQ9 Item Example 44254-1
.... 14.329 PHQ9 Item Example 44255-8
.... 14.330 PHQ9 Item Example 44258-2
.... 14.331 PHQ9 Item Example 44259-0
.... 14.332 PHQ9 Item Example 44260-8
.... 14.333 PHQ9 Item Example 44261-6
.... 14.334 PHQ9 Item Example 69722-7
.... 14.335 PHQ9 Panel Example 44249-1
.... 14.336 Platelets Example
.... 14.337 Practitioner 1 Example
.... 14.338 Practitioner 2 Example
.... 14.339 Practitioner Pharmacist Example
.... 14.340 PractitionerRole_Practitioner_Endpoint_Bundle_Example Example
.... 14.341 Prapare Item Example 54899-0
.... 14.342 Prapare Item Example 56051-6
.... 14.343 Prapare Item Example 56799-0
.... 14.344 Prapare Item Example 63512-8
.... 14.345 Prapare Item Example 63586-2
.... 14.346 Prapare Item Example 67875-5
.... 14.347 Prapare Item Example 71802-3
.... 14.348 Prapare Item Example 76437-3
.... 14.349 Prapare Item Example 76501-6
.... 14.350 Prapare Item Example 82589-3
.... 14.351 Prapare Item Example 93026-3
.... 14.352 Prapare Item Example 93027-1
.... 14.353 Prapare Item Example 93028-9
.... 14.354 Prapare Item Example 93029-7
.... 14.355 Prapare Item Example 93030-5
.... 14.356 Prapare Item Example 93033-9
.... 14.357 Prapare Item Example 93034-7
.... 14.358 Prapare Item Example 93035-4
.... 14.359 Prapare Item Example 93038-8
.... 14.360 Prapare Multiselect-Item Example 32624-9-Answer0
.... 14.361 Prapare Multiselect-Item Example 32624-9-Answer1
.... 14.362 Prapare Multiselect-Item Example 93031-3-Answer0
.... 14.363 Prapare Multiselect-Item Example 93031-3-Answer1
.... 14.364 Prapare Panel Example 93025-5
.... 14.365 Prapare Panel Example 93039-6
.... 14.366 Prapare Panel Example 93040-4
.... 14.367 Prapare Panel Example 93041-2
.... 14.368 Prapare Panel Example 93042-0
.... 14.369 PRAPARE Panel Example 93043-8
.... 14.370 Pregnancy Intent Observation Example
.... 14.371 Pregnancy Status Observation Example
.... 14.372 Procedure Defibrillator Implant Example
.... 14.373 Pulse intensity Palpation Example
.... 14.374 Q-T interval {EKG lead} Example
.... 14.375 QRS dur {EKG lead} Example
.... 14.376 Questionnaire Hunger Vital Sign (HVS) Example
.... 14.377 Questionnaire PHQ-9 Example
.... 14.378 Questionnaire PRAPARE Example
.... 14.379 QuestionnaireResponse Glascow Coma Score Example
.... 14.380 QuestionnaireResponse Hunger Vital Sign (HVS) Example
.... 14.381 QuestionnaireResponse PHQ-9 Example
.... 14.382 QuestionnaireResponse PRAPARE Example
.... 14.383 Rehab Example
.... 14.384 Respiratory Rate Example
.... 14.385 Saint Luke W Endpoint Example
.... 14.386 SDOH Problem/Health Concern Example
.... 14.387 Serum BUN Example
.... 14.388 Serum Calcium Example
.... 14.389 Serum Chloride Example
.... 14.390 Serum CO2 Example
.... 14.391 Serum Creatinine Example
.... 14.392 Serum Glucose Example
.... 14.393 Serum Potassium Example
.... 14.394 Serum Sodium Example
.... 14.395 Serum Specimen Example
.... 14.396 ServiceRequest BMP Example
.... 14.397 ServiceRequest CBC Example
.... 14.398 ServiceRequest Chest XRay Example
.... 14.399 ServiceRequest EKG Example
.... 14.400 ServiceRequest Food Pantry Referral Example
.... 14.401 ServiceRequest for Rehab Example
.... 14.402 Simple Observation Cognitive Status Example
.... 14.403 Simple Observation Disability Status Example
.... 14.404 Simple Observation Functional Status Example
.... 14.405 Simple Observation SDOH Example
.... 14.406 Some Day Smoker Example
.... 14.407 Substance Use Status Example
.... 14.408 Taps Item Example 75889-6
.... 14.409 Taps Item Example 88037-7
.... 14.410 Taps Item Example 96842-0
.... 14.411 Taps Item Example 96843-8
.... 14.412 Taps Item Example 96844-6
.... 14.413 Taps Panel Example 96841-2
.... 14.414 Temperature Example
.... 14.415 Tobacco, Alcohol, Prescription medications, and other Substance use screen (TAPS) Questionnaire Example
.... 14.416 Tobacco, Alcohol, Prescription medications, and other Substance use screen (TAPS) QuestionnaireResponse Example
.... 14.417 Treatment Intervention Preference Example
.... 14.418 UDI 1 Example
.... 14.419 Urine Specimen Example
.... 14.420 Urobilinogen Example
.... 14.421 US Core Version 3.1.1 Model Definition
.... 14.422 US Core Version 4.0.0 Model Definition
.... 14.423 US Core Version 5.0.1 Model Definition
.... 14.424 US Core Version 6.1.0 Model Definition
.... 14.425 US Core Version 7.0.0 Model Definition
.... 14.426 US Core Version 8.0.0 Model Definition
.... 14.427 Uscore Med1 Example
.... 14.428 Uscore Med2 Example
.... 14.429 Weight Example
.... 14.430 Whole Blood Specimen Example
.... 14.431 Xray Chest Findings Example
.... 14.432 Xray Chest Impression Example