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

US Core Implementation Guide, published by HL7 International - Cross-Group Projects. This is not an authorized publication; it is the continuous build for version 6.0.0-preview). 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

...0 Table of Contents
...1 Home
....2 Conformance
....2.1 General Requirements
.....2.2 Must Support
.....2.2.1 Observation Summary Table
....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
...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 USCoreLocationAddressCity
....13.56 USCoreLocationAddressPostalcode
....13.57 USCoreLocationAddressState
....13.58 USCoreLocationAddress
....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 USCorePatientGenderIdentity
....13.79 USCorePatientGender
....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 USCoreRace
....13.94 USCoreRelatedpersonId
....13.95 USCoreRelatedpersonName
....13.96 USCoreRelatedpersonPatient
....13.97 USCoreServicerequestAuthored
....13.98 USCoreServicerequestCategory
....13.99 USCoreServicerequestCode
....13.100 USCoreServicerequestId
....13.101 USCoreServicerequestPatient
....13.102 USCoreServicerequestStatus
....13.103 US Core AllergyIntolerance Profile
....13.104 US Core Blood Pressure Profile
....13.105 US Core BMI Profile
....13.106 US Core Body Height Profile
....13.107 US Core Body Temperature Profile
....13.108 US Core Body Weight Profile
....13.109 US Core CarePlan Profile
....13.110 US Core CareTeam Profile
....13.111 US Core Condition Encounter Diagnosis Profile
....13.112 US Core Condition Problems and Health Concerns Profile
....13.113 US Core Coverage Profile
....13.114 US Core DiagnosticReport Profile for Laboratory Results Reporting
....13.115 US Core DiagnosticReport Profile for Report and Note Exchange
....13.116 US Core DocumentReference Profile
....13.117 US Core Encounter Profile
....13.118 US Core Goal Profile
....13.119 US Core Head Circumference Profile
....13.120 US Core Heart Rate Profile
....13.121 US Core Immunization Profile
....13.122 US Core Implantable Device Profile
....13.123 US Core Location Profile
....13.124 US Core Medication Profile
....13.125 US Core MedicationDispense Profile
....13.126 US Core MedicationRequest Profile
....13.127 US Core Observation Clinical Result Profile
....13.128 US Core Laboratory Result Observation Profile
....13.129 US Core Observation Occupation Profile
....13.130 US Core Observation Pregnancy Intent Profile
....13.131 US Core Observation Pregnancy Status Profile
....13.132 US Core Observation Screening Assessment Profile
....13.133 US Core Observation Sexual Orientation Profile
....13.134 US Core Organization Profile
....13.135 US Core Pediatric BMI for Age Observation Profile
....13.136 US Core Pediatric Weight for Height Observation Profile
....13.137 US Core Practitioner Profile
....13.138 US Core PractitionerRole Profile
....13.139 US Core Procedure Profile
....13.140 US Core Provenance Profile
....13.141 US Core Pulse Oximetry Profile
....13.142 US Core RelatedPerson Profile
....13.143 US Core Respiratory Rate Profile
....13.144 US Core Simple Observation Profile
....13.145 US Core Smoking Status Observation Profile
....13.146 US Core Specimen Profile
....13.147 US Core Vital Signs Profile
....13.148 US Core Pediatric Head Occipital Frontal Circumference Percentile Profile
....13.149 US Core Patient Profile
....13.150 US Core ServiceRequest Profile
....13.151 US Core Birth Sex Extension
....13.152 US Core Direct email Extension
....13.153 US Core Ethnicity Extension
....13.154 US Core Gender Identity Extension
....13.155 US Core Jurisdiction Extension
....13.156 US Core Race Extension
....13.157 US Core Sex For Clinical Use
....13.158 US Core Tribal Affiliation Extension
....13.159 Birth Sex
....13.160 Detailed ethnicity
....13.161 Detailed Race
....13.162 OMB Ethnicity Categories
....13.163 OMB Race Categories
....13.164 Language codes with language and optionally a region modifier
....13.165 US Core Clinical Note Type
....13.166 US Core Common SDOH Assessments
....13.167 US Core Condition Codes
....13.168 US Core Diagnostic Report Category Codes
....13.169 US Core Non Laboratory Codes
....13.170 US Core Discharge Disposition
....13.171 US Core DocumentReference Category
....13.172 US Core DocumentReference Type
....13.173 US Core Encounter Type
....13.174 US Core Goal Codes
....13.175 US Core Narrative Status
....13.176 US Core Observation Category
....13.177 US Core Status for Smoking Status Observation
....13.178 US Core Smoking Status Max-Binding
....13.179 US Core Observation Value Codes (SNOMED-CT)
....13.180 US Core Pregnancy Intent Codes
....13.181 US Core Pregnancy Status Codes
....13.182 US Core Problem or Health Concern
....13.183 US Core Procedure Codes
....13.184 US Core Provenance Participant Type Codes
....13.185 US Core Provider Role (NUCC)
....13.186 US Core ServiceRequest Category Codes
....13.187 US Core Sex for Clinical Use Codes
....13.188 US Core Sexual Orientation
....13.189 US Core Simple Observation Category
....13.190 US Core Simple Observation Codes
....13.191 US Core Smoking Status Observation Codes
....13.192 US Core Survey Codes
....13.193 USPS Two Letter Alphabetic Codes
....13.194 US Core Vital Signs ValueSet
....13.195 US Core Laboratory Test Codes
....13.196 US Core CarePlan Category Extension Codes
....13.197 US Core Condition Category Extension Codes
....13.198 US Core Category
....13.199 US Core DocumentReferences Category Codes
....13.200 US Core Provenance Participant Type Extension Codes
....13.201 US Core Sex for Clinical Use
....13.202 Device Defib Example
....13.203 Device Knee Example
....13.204 DXA Bone density quantitative measurement panel Example
....13.205 DiagnosticReport Cardiology Report Example
....13.206 DiagnosticReport Chest Xray Report Example
....13.207 10 minute Apgar Color Example
....13.208 10 minute Apgar Heart Rate Example
....13.209 10 minute Apgar Muscle Tone Example
....13.210 10 minute Apgar Reflex Irritability Example
....13.211 10 minute Apgar Respiratory effort Example
....13.212 10 Minute Apgar Score Panel Example
....13.213 10 Minute Apgar Score Example
....13.214 Ahc-Hrsn Item Example 44250-9
....13.215 Ahc-Hrsn Item Example 44255-8
....13.216 Ahc-Hrsn Item Example 68516-4
....13.217 Ahc-Hrsn Item Example 68517-2
....13.218 Ahc-Hrsn Item Example 68524-8
....13.219 Ahc-Hrsn Item Example 69858-9
....13.220 Ahc-Hrsn Item Example 69861-3
....13.221 Ahc-Hrsn Item Example 76513-1
....13.222 Ahc-Hrsn Item Example 89555-7
....13.223 Ahc-Hrsn Item Example 93038-8
....13.224 Ahc-Hrsn Item Example 93159-2
....13.225 Ahc-Hrsn Item Example 95530-2
....13.226 Ahc-Hrsn Item Example 96780-2
....13.227 Ahc-Hrsn Item Example 96781-0
....13.228 Ahc-Hrsn Item Example 96782-8
....13.229 Ahc-Hrsn Item Example 96842-0
....13.230 Ahc-Hrsn Item Example 97027-7
....13.231 Ahc-Hrsn Panel Example 96777-8
....13.232 Hvs Item Example 88122-7
....13.233 Hvs Item Example 88123-5
....13.234 Hvs Item Example 88124-3
....13.235 Hvs Panel Example 88121-9
....13.236 PHQ9 Item Example 44250-9
....13.237 PHQ9 Item Example 44251-7
....13.238 PHQ9 Item Example 44252-5
....13.239 PHQ9 Item Example 44253-3
....13.240 PHQ9 Item Example 44254-1
....13.241 PHQ9 Item Example 44255-8
....13.242 PHQ9 Item Example 44258-2
....13.243 PHQ9 Item Example 44259-0
....13.244 PHQ9 Item Example 44260-8
....13.245 PHQ9 Item Example 44261-6
....13.246 PHQ9 Item Example 69722-7
....13.247 PHQ9 Panel Example 44249-1
....13.248 Prapare Item Example 54899-0
....13.249 Prapare Item Example 56051-6
....13.250 Prapare Item Example 56799-0
....13.251 Prapare Item Example 63512-8
....13.252 Prapare Item Example 63586-2
....13.253 Prapare Item Example 67875-5
....13.254 Prapare Item Example 71802-3
....13.255 Prapare Item Example 76437-3
....13.256 Prapare Item Example 76501-6
....13.257 Prapare Item Example 82589-3
....13.258 Prapare Item Example 93026-3
....13.259 Prapare Item Example 93027-1
....13.260 Prapare Item Example 93028-9
....13.261 Prapare Item Example 93029-7
....13.262 Prapare Item Example 93030-5
....13.263 Prapare Item Example 93033-9
....13.264 Prapare Item Example 93034-7
....13.265 Prapare Item Example 93035-4
....13.266 Prapare Item Example 93038-8
....13.267 Prapare Multiselect-Item Example 32624-9-Answer0
....13.268 Prapare Multiselect-Item Example 32624-9-Answer1
....13.269 Prapare Multiselect-Item Example 93031-3-Answer0
....13.270 Prapare Multiselect-Item Example 93031-3-Answer1
....13.271 Prapare Panel Example 93025-5
....13.272 Prapare Panel Example 93039-6
....13.273 Prapare Panel Example 93040-4
....13.274 Prapare Panel Example 93041-2
....13.275 Prapare Panel Example 93042-0
....13.276 PRAPARE Panel Example 93043-8
....13.277 Simple Observation Cognitive Status Example
....13.278 Simple Observation Disability Status Example
....13.279 Simple Observation SDOH Example
....13.280 PractitionerRole_Practitioner_Endpoint_Bundle_Example Example
....13.281 Procedure Defibrillator Implant Example
....13.282 QuestionnaireResponse Example 44250-9
....13.283 QuestionnaireResponse AHC HRSN Screening Example
....13.284 QuestionnaireResponse PRAPARE Example
....13.285 QuestionnaireResponse Hunger Vital Sign [HVS] Example
....13.286 AllergyIntolerance Example
....13.287 AllergyIntolerance Provenance Example
....13.288 Blood Pressure Example
....13.289 BMI Example
....13.290 BP Data Absent Example
....13.291 Capillary refill Time Nail Bed Example
....13.292 CareTeam Example
....13.293 Colonoscopy Example
....13.294 SDOH Problem/Health Concern Example
....13.295 Condition Duodenal Ulcer Example
....13.296 Encounter Diagnosis Example 1
....13.297 Encounter Diagnosis Example 2
....13.298 Coverage Example
....13.299 CBC Example
....13.300 Metabolic Panel Example
....13.301 DXA Femur-L ArMass BMD Example
....13.302 DXA Femur-L T-score BMD Example
....13.303 DXA Femur-L Z-score BMD Example
....13.304 DXA Hip-L ArMass BMD Example
....13.305 DXA Hip-L T-score BMD Example
....13.306 DXA Hip-L Z-score BMD Example
....13.307 EKG impression Example
....13.308 EKG lead Example
....13.309 Encounter 1036 Example
....13.310 Encounter Delivery Example
....13.311 Encounter 1 Example
....13.312 Episode Summary Example
....13.313 Organization 2 Example
....13.314 ServiceRequest Example
....13.315 Goal 1 Example
....13.316 Goal 2 Example
....13.317 Head Circumference Example
....13.318 Health Concern Example
....13.319 Heart rate rhythm Example
....13.320 Heart Rate Example
....13.321 Height Example
....13.322 HL7East Example
....13.323 Imm 1 Example
....13.324 Jugular vein distension Example
....13.325 Length Example
....13.326 Hospital Location
....13.327 Chest Xray Example
....13.328 EKG Strip Image
....13.329 Medication Dispense Example
....13.330 MedicationRequest Coded Oral Axid Example
....13.331 MedicationRequest Contained Oral Axid Example
....13.332 MedicationRequest Referenced Oral Axid Example
....13.333 MedicationRequest Self Tylenol Example
....13.334 Missing Coded Data Example
....13.335 Blood Glucose Example
....13.336 BUN Example
....13.337 Erythrocytes Example
....13.338 Hemoglobin Example
....13.339 MCHC Example
....13.340 Neutrophils Example
....13.341 Occupation Observation Example
....13.342 Pregnancy Intent Observation Example
....13.343 Pregnancy Status Observation Example
....13.344 Observation SatO2 FiO2 Example
....13.345 Serum Calcium Example
....13.346 Serum Chloride Example
....13.347 Serum CO2 Example
....13.348 Serum Creatinine Example
....13.349 Serum Potassium Example
....13.350 Serum Sodium Example
....13.351 Serum Total Bilirubin Example
....13.352 Xray Chest Findings Example
....13.353 Xray Chest Impression Example
....13.354 OFC Percentile Example
....13.355 Organization Acme Lab Example
....13.356 Organization Acme Payer Example
....13.357 Organization Holy Healthcare Example
....13.358 Oxygen Saturation Example
....13.359 P-R interval {EKG lead} Example
....13.360 Patient Child Example
....13.361 Deceased Patient Example
....13.362 Patient Example
....13.363 Patient Infant Example
....13.364 Pediatric BMI Example
....13.365 Pediatric Wt Example
....13.366 Practitioner 1 Example
....13.367 Practitioner 2 Example
....13.368 Practitioner Pharmacist Example
....13.369 Rehab Example
....13.370 Pulse intensity Palpation Example
....13.371 Q-T interval {EKG lead} Example
....13.372 QRS dur {EKG lead} Example
....13.373 Patient Niece Example
....13.374 Respiratory Rate Example
....13.375 Saint Luke W Endpoint Example
....13.376 ServiceRequest Defibrillator Implant Example
....13.377 ServiceRequest for Rehab Example
....13.378 Sexual Orientation Observation Example
....13.379 Some Day Smoker Example
....13.380 Serum Specimen Example
....13.381 Temperature Example
....13.382 UDI 1 Example
....13.383 Urobilinogen Example
....13.384 Uscore Med1 Example
....13.385 Uscore Med2 Example
....13.386 Weight Example