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