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