US Core Implementation Guide
5.0.1 - STU5 Release 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 5.0.1). 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 Social Determinants of Health (SDOH)
....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 Artifacts Summary
....12.1 US Core Client CapabilityStatement
....12.2 US Core Server CapabilityStatement
....12.3 US Core Fetch DocumentReference
....12.4 USCoreAllergyintoleranceClinicalStatus
....12.5 USCoreAllergyintolerancePatient
....12.6 USCoreCareplanCategory
....12.7 USCoreCareplanDate
....12.8 USCoreCareplanPatient
....12.9 USCoreCareplanStatus
....12.10 USCoreCareteamPatient
....12.11 USCoreCareTeamRole
....12.12 USCoreCareteamStatus
....12.13 USCoreConditionAbatementDate
....12.14 USCoreConditionAssertedDate
....12.15 USCoreConditionCategory
....12.16 USCoreConditionClinicalStatus
....12.17 USCoreConditionCode
....12.18 USCoreConditionEncounter
....12.19 USCoreConditionOnsetDate
....12.20 USCoreConditionPatient
....12.21 USCoreConditionRecordedDate
....12.22 USCoreDevicePatient
....12.23 USCoreDeviceType
....12.24 USCoreDiagnosticreportCategory
....12.25 USCoreDiagnosticreportCode
....12.26 USCoreDiagnosticreportDate
....12.27 USCoreDiagnosticreportPatient
....12.28 USCoreDiagnosticreportStatus
....12.29 USCoreDocumentreferenceCategory
....12.30 USCoreDocumentreferenceDate
....12.31 USCoreDocumentreferenceId
....12.32 USCoreDocumentreferencePatient
....12.33 USCoreDocumentreferencePeriod
....12.34 USCoreDocumentreferenceStatus
....12.35 USCoreDocumentreferenceType
....12.36 USCoreEncounterClass
....12.37 USCoreEncounterDate
....12.38 USCoreEncounterDischargeDisposition
....12.39 USCoreEncounterId
....12.40 USCoreEncounterIdentifier
....12.41 USCoreEncounterLocation
....12.42 USCoreEncounterPatient
....12.43 USCoreEncounterStatus
....12.44 USCoreEncounterType
....12.45 USCoreEthnicity
....12.46 USCoreGoalDescription
....12.47 USCoreGoalLifecycleStatus
....12.48 USCoreGoalPatient
....12.49 USCoreGoalTargetDate
....12.50 USCoreImmunizationDate
....12.51 USCoreImmunizationPatient
....12.52 USCoreImmunizationStatus
....12.53 USCoreLocationAddressCity
....12.54 USCoreLocationAddressPostalcode
....12.55 USCoreLocationAddressState
....12.56 USCoreLocationAddress
....12.57 USCoreLocationName
....12.58 USCoreMedicationrequestAuthoredon
....12.59 USCoreMedicationrequestEncounter
....12.60 USCoreMedicationrequestIntent
....12.61 USCoreMedicationrequestPatient
....12.62 USCoreMedicationrequestStatus
....12.63 USCoreObservationCategory
....12.64 USCoreObservationCode
....12.65 USCoreObservationDate
....12.66 USCoreObservationPatient
....12.67 USCoreObservationStatus
....12.68 USCoreOrganizationAddress
....12.69 USCoreOrganizationName
....12.70 USCorePatientBirthdate
....12.71 USCorePatientFamily
....12.72 USCorePatientGenderIdentity
....12.73 USCorePatientGender
....12.74 USCorePatientGiven
....12.75 USCorePatientId
....12.76 USCorePatientIdentifier
....12.77 USCorePatientName
....12.78 USCorePractitionerId
....12.79 USCorePractitionerIdentifier
....12.80 USCorePractitionerName
....12.81 USCorePractitionerrolePractitioner
....12.82 USCorePractitionerroleSpecialty
....12.83 USCoreProcedureCode
....12.84 USCoreProcedureDate
....12.85 USCoreProcedurePatient
....12.86 USCoreProcedureStatus
....12.87 USCoreQuestionnaireresponseAuthored
....12.88 USCoreQuestionnaireresponseId
....12.89 USCoreQuestionnaireresponsePatient
....12.90 USCoreQuestionnaireresponseQuestionnaire
....12.91 USCoreQuestionnaireresponseStatus
....12.92 USCoreQuestionnaireresponseTag
....12.93 USCoreRace
....12.94 USCoreRelatedpersonId
....12.95 USCoreRelatedpersonPatient
....12.96 USCoreServicerequestAuthored
....12.97 USCoreServicerequestCategory
....12.98 USCoreServicerequestCode
....12.99 USCoreServicerequestId
....12.100 USCoreServicerequestPatient
....12.101 USCoreServicerequestStatus
....12.102 US Core AllergyIntolerance Profile
....12.103 US Core Blood Pressure Profile
....12.104 US Core BMI Profile
....12.105 US Core Body Height Profile
....12.106 US Core Body Temperature Profile
....12.107 US Core Body Weight Profile
....12.108 US Core CarePlan Profile
....12.109 US Core CareTeam Profile
....12.110 US Core Condition Encounter Diagnosis Profile
....12.111 US Core Condition Problems and Health Concerns Profile
....12.112 US Core DiagnosticReport Profile for Laboratory Results Reporting
....12.113 US Core DiagnosticReport Profile for Report and Note Exchange
....12.114 US Core DocumentReference Profile
....12.115 US Core Encounter Profile
....12.116 US Core Goal Profile
....12.117 US Core Head Circumference Profile
....12.118 US Core Heart Rate Profile
....12.119 US Core Immunization Profile
....12.120 US Core Implantable Device Profile
....12.121 US Core Location Profile
....12.122 US Core Medication Profile
....12.123 US Core MedicationRequest Profile
....12.124 US Core Observation Clinical Test Result Profile
....12.125 US Core Observation Imaging Result Profile
....12.126 US Core Laboratory Result Observation Profile
....12.127 US Core Observation SDOH Assessment Profile
....12.128 US Core Observation Sexual Orientation Profile
....12.129 US Core Observation Social History Profile
....12.130 US Core Observation Survey Profile
....12.131 US Core Organization Profile
....12.132 US Core Pediatric BMI for Age Observation Profile
....12.133 US Core Pediatric Weight for Height Observation Profile
....12.134 US Core Practitioner Profile
....12.135 US Core PractitionerRole Profile
....12.136 US Core Procedure Profile
....12.137 US Core Provenance Profile
....12.138 US Core Pulse Oximetry Profile
....12.139 US Core QuestionnaireResponse Profile
....12.140 US Core RelatedPerson Profile
....12.141 US Core Respiratory Rate Profile
....12.142 US Core Smoking Status Observation Profile
....12.143 US Core Vital Signs Profile
....12.144 US Core Pediatric Head Occipital-frontal Circumference Percentile Profile
....12.145 US Core Patient Profile
....12.146 US Core ServiceRequest Profile
....12.147 US Core Birth Sex Extension
....12.148 US Core Direct email Extension
....12.149 US Core Ethnicity Extension
....12.150 US Core Extension Questionnaire URI
....12.151 US Core Gender Identity Extension
....12.152 US Core Race Extension
....12.153 US Core Survey Codes
....12.154 US Core Tags ValueSet
....12.155 Detailed ethnicity
....12.156 Detailed Race
....12.157 US Core Discharge Disposition
....12.158 OMB Ethnicity Categories
....12.159 OMB Race Categories
....12.160 Language codes with language and optionally a region modifier
....12.161 Birth Sex
....12.162 US Core Clinical Note Type
....12.163 US Core Clinical Test Codes
....12.164 US Core Common SDOH Assessments
....12.165 US Core Condition Codes
....12.166 US Core Diagnostic Report Category Codes
....12.167 US Core Diagnostic Report Laboratory Codes
....12.168 US Core Non Laboratory Codes
....12.169 US Core DocumentReference Category
....12.170 US Core DocumentReference Type
....12.171 US Core Encounter Type
....12.172 US Core Goal Codes
....12.173 US Core Narrative Status
....12.174 US Core Observation Category
....12.175 US Core Smoking Status Max-Binding
....12.176 US Core Status for Smoking Status Observation
....12.177 US Core Observation Value Codes (SNOMED-CT)
....12.178 US Core Problem or Health Concern
....12.179 US Core Procedure Codes
....12.180 US Core Provenance Participant Type Codes
....12.181 US Core Provider Role (NUCC)
....12.182 US Core ServiceRequest Category Codes
....12.183 US Core Sexual Orientation
....12.184 US Core Smoking Status Observation Codes
....12.185 USPS Two Letter Alphabetic Codes
....12.186 US Core Vital Signs ValueSet
....12.187 US Core Observation Category Extension Codes
....12.188 US Core Tags CodeSystem
....12.189 US Core CarePlan Category Extension Codes
....12.190 US Core Condition Category Extension Codes
....12.191 US Core DocumentReferences Category Codes
....12.192 US Core Provenance Participant Type Extension Codes
....12.193 Device Defib Example
....12.194 Device Knee Example
....12.195 DXA Bone density quantitative measurement panel Example
....12.196 DiagnosticReport Cardiology Report Example
....12.197 DiagnosticReport Chest Xray Report Example
....12.198 10 minute Apgar Color Example
....12.199 10 minute Apgar Heart Rate Example
....12.200 10 minute Apgar Muscle Tone Example
....12.201 10 minute Apgar Reflex Irritability Example
....12.202 10 minute Apgar Respiratory effort Example
....12.203 10 Minute Apgar Score Panel Example
....12.204 10 Minute Apgar Score Example
....12.205 Ahc-Hrsn Item Example 44250-9
....12.206 Ahc-Hrsn Item Example 44255-8
....12.207 Ahc-Hrsn Item Example 68516-4
....12.208 Ahc-Hrsn Item Example 68517-2
....12.209 Ahc-Hrsn Item Example 68524-8
....12.210 Ahc-Hrsn Item Example 69858-9
....12.211 Ahc-Hrsn Item Example 69861-3
....12.212 Ahc-Hrsn Item Example 76513-1
....12.213 Ahc-Hrsn Item Example 89555-7
....12.214 Ahc-Hrsn Item Example 93038-8
....12.215 Ahc-Hrsn Item Example 93159-2
....12.216 Ahc-Hrsn Item Example 95530-2
....12.217 Ahc-Hrsn Item Example 96780-2
....12.218 Ahc-Hrsn Item Example 96781-0
....12.219 Ahc-Hrsn Item Example 96782-8
....12.220 Ahc-Hrsn Item Example 96842-0
....12.221 Ahc-Hrsn Item Example 97027-7
....12.222 Ahc-Hrsn Panel Example 96777-8
....12.223 Hvs Item Example 88122-7
....12.224 Hvs Item Example 88123-5
....12.225 Hvs Item Example 88124-3
....12.226 Hvs Panel Example 88121-9
....12.227 Prapare Item Example 54899-0
....12.228 Prapare Item Example 56051-6
....12.229 Prapare Item Example 56799-0
....12.230 Prapare Item Example 63512-8
....12.231 Prapare Item Example 63586-2
....12.232 Prapare Item Example 67875-5
....12.233 Prapare Item Example 71802-3
....12.234 Prapare Item Example 76437-3
....12.235 Prapare Item Example 76501-6
....12.236 Prapare Item Example 82589-3
....12.237 Prapare Item Example 93026-3
....12.238 Prapare Item Example 93027-1
....12.239 Prapare Item Example 93028-9
....12.240 Prapare Item Example 93029-7
....12.241 Prapare Item Example 93030-5
....12.242 Prapare Item Example 93033-9
....12.243 Prapare Item Example 93034-7
....12.244 Prapare Item Example 93035-4
....12.245 Prapare Item Example 93038-8
....12.246 Prapare Multiselect-Item Example 32624-9-Answer0
....12.247 Prapare Multiselect-Item Example 32624-9-Answer1
....12.248 Prapare Multiselect-Item Example 93031-3-Answer0
....12.249 Prapare Multiselect-Item Example 93031-3-Answer1
....12.250 Prapare Panel Example 93025-5
....12.251 Prapare Panel Example 93039-6
....12.252 Prapare Panel Example 93040-4
....12.253 Prapare Panel Example 93041-2
....12.254 Prapare Panel Example 93042-0
....12.255 PRAPARE Panel Example 93043-8
....12.256 PractitionerRole_Practitioner_Endpoint_Bundle_Example Example
....12.257 Procedure R4 Defib Implant Example
....12.258 AHC HRSN Screening Example
....12.259 PRAPARE Example
....12.260 Glascow Coma Score Example
....12.261 Hunger Vital Sign [HVS] Example
....12.262 Acme Lab Example
....12.263 AllergyIntolerance Example
....12.264 AllergyIntolerance Provenance Example
....12.265 Blood Pressure Example
....12.266 BMI Example
....12.267 BP Data Absent Example
....12.268 Capillary refill Time Nail Bed Example
....12.269 CareTeam Example
....12.270 Colonoscopy Example
....12.271 SDOH Problem/Health Concern Example
....12.272 Encounter Diagnosis Example 1
....12.273 Encounter Diagnosis Example 2
....12.274 CBC Example
....12.275 Metabolic Panel Example
....12.276 DXA Femur-L ArMass BMD Example
....12.277 DXA Femur-L T-score BMD Example
....12.278 DXA Femur-L Z-score BMD Example
....12.279 DXA Hip-L ArMass BMD Example
....12.280 DXA Hip-L T-score BMD Example
....12.281 DXA Hip-L Z-score BMD Example
....12.282 EKG impression Example
....12.283 EKG lead Example
....12.284 Encounter 1036 Example
....12.285 Encounter Delivery Example
....12.286 Encounter 1 Example
....12.287 Episode Summary Example
....12.288 Organization 2 Example
....12.289 ServiceRequest Example
....12.290 Goal 1 Example
....12.291 Goal 2 Example
....12.292 Head Circumference Example
....12.293 Health Concern Example
....12.294 Heart rate rhythm Example
....12.295 Heart Rate Example
....12.296 Height Example
....12.297 HL7East Example
....12.298 Imm 1 Example
....12.299 Jugular vein distension Example
....12.300 Length Example
....12.301 Hospital Location
....12.302 Chest Xray Example
....12.303 EKG Strip Image
....12.304 Blood Glucose Example
....12.305 BUN Example
....12.306 Erythrocytes Example
....12.307 Hemoglobin Example
....12.308 MCHC Example
....12.309 Neutrophils Example
....12.310 Observation SatO2 FiO2 Example
....12.311 Serum Calcium Example
....12.312 Serum Chloride Example
....12.313 Serum CO2 Example
....12.314 Serum Creatinine Example
....12.315 Serum Potassium Example
....12.316 Serum Sodium Example
....12.317 Serum Total Bilirubin Example
....12.318 Xray Chest Findings Example
....12.319 Xray Chest Impression Example
....12.320 OFC Percentile Example
....12.321 Oxygen Saturation Example
....12.322 P-R interval {EKG lead} Example
....12.323 Patient Child Example
....12.324 Patient Example
....12.325 Patient Infant Example
....12.326 Pediatric BMI Example
....12.327 Pediatric Wt Example
....12.328 Practitioner 1 Example
....12.329 Practitioner 2 Example
....12.330 Pulse intensity Palpation Example
....12.331 Q-T interval {EKG lead} Example
....12.332 QRS dur {EKG lead} Example
....12.333 Rehab Example
....12.334 Patient Niece Example
....12.335 Respiratory Rate Example
....12.336 Saint Luke W Endpoint Example
.....12.336.1 Endpoint
....12.337 Self Tylenol Example
....12.338 Sexual Orientation Observation Example
....12.339 Social History Assessment Example
....12.340 Some Day Smoker Example
....12.341 Temperature Example
....12.342 UDI 1 Example
....12.343 Urobilinogen Example
....12.344 Uscore Med1 Example
....12.345 Uscore Med2 Example
....12.346 Uscore MO1 Example
....12.347 Uscore MO2 Example
.....12.347.1 Medication
....12.348 Uscore MO3 Example
....12.349 Weight Example