US Public Health Profiles Library
1.0.0 - STU1

US Public Health Profiles Library, published by HL7 Public Health Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-us-ph-common-library-ig/ and changes regularly. See the Directory of published versions

## Downloads

Full Implementation Guide

The entire implementation guide (including the HTML files, definitions, validation information, etc.) may be downloaded here. In addition there are format specific definitions files.

- XML
- JSON
- TTL

Examples

All the examples that are used in this Implementation Guide available for download:

- XML
- JSON
- TTl

### Cross Version Analysis

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (hl7.fhir.us.ph-library.r4) and R4B (hl7.fhir.us.ph-library.r4b) are available.

### Dependency Table

IG | Package | FHIR | Comment
--- | --- | --- | ---
US Public Health Profiles Library | hl7.fhir.us.ph-library#1.0.0 | R4 |
HL7 Terminology (THO) | hl7.terminology.r4#5.3.0 | R4 | Automatically added as a dependency - all IGs depend on HL7 Terminology
US Core Implementation Guide | hl7.fhir.us.core#5.0.1 | R4 |
HL7 Terminology (THO) | hl7.terminology.r4#3.1.0 | R4 |
Bulk Data Access IG | hl7.fhir.uv.bulkdata#2.0.0 | R4 |
SMART App Launch | hl7.fhir.uv.smart-app-launch#2.0.0 | R4 |
| us.nlm.vsac#0.7.0 | R4 |
Structured Data Capture | hl7.fhir.uv.sdc#3.0.0 | R4 |
FHIR R4 package : Examples | hl7.fhir.r4.examples#4.0.1 | R4 |
| us.cdc.phinvads#0.12.0 | R4 |
| us.nlm.vsac#0.11.0 | R4 |
FHIR Extensions Pack | hl7.fhir.uv.extensions#1.0.0 | R5 |
HL7 Terminology (THO) | hl7.terminology.r5#5.0.0 | R5 |

Package hl7.fhir.uv.bulkdata#2.0.0 FHIR based approach for exporting large data sets from a FHIR server to a client application (built Fri, Nov 26, 2021 05:56+1100+11:00)

Package hl7.fhir.r4.examples#4.0.1 Example resources in the R4 version of the FHIR standard

Package hl7.fhir.uv.sdc#3.0.0 The SDC specification provides an infrastructure to standardize the capture and expanded use of patient-level data collected within an EHR. This includes two components: * Support more sophisticated questionnaire/form use-cases such as those needed for research, oncology, pathology and other clinical domains. *Support pre-population and auto-population of EHR data into forms/questionnaires for uses outside direct clinical care (patient safety, adverse event reporting, public health reporting, etc.). (built Tue, Mar 8, 2022 18:32+0000+00:00)

Package hl7.fhir.us.core#5.0.1 The US Core Implementation Guide is based on FHIR Version R4 and defines the minimum conformance requirements for accessing patient data. The Argonaut pilot implementations, ONC 2015 Edition Common Clinical Data Set (CCDS), and ONC U.S. Core Data for Interoperability (USCDI) v1 provided the requirements for this guide. The prior Argonaut search and vocabulary requirements, based on FHIR DSTU2, are updated in this guide to support FHIR Version R4. This guide was used as the basis for further testing and guidance by the Argonaut Project Team to provide additional content and guidance specific to Data Query Access for purpose of ONC Certification testing. These profiles are the foundation for future US Realm FHIR implementation guides. In addition to Argonaut, they are used by DAF-Research, QI-Core, and CIMI. Under the guidance of HL7 and the HL7 US Realm Steering Committee, the content will expand in future versions to meet the needs specific to the US Realm. These requirements were originally developed, balloted, and published in FHIR DSTU2 as part of the Office of the National Coordinator for Health Information Technology (ONC) sponsored Data Access Framework (DAF) project. For more information on how DAF became US Core see the US Core change notes. (built Wed, Jun 22, 2022 19:44+0000+00:00)

Package hl7.fhir.uv.extensions#1.0.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sun, Mar 26, 2023 08:46+1100+11:00)

### Global Profiles Table

There are no Global profiles defined

### IP Statements

This publication includes IP covered under the following statements.

- Copyright HL7. Licensed under creative commons public domain
  Show Usage
  - identifierType: Bundle/us-ph-content-bundle-example, Bundle/us-ph-document-bundle-example, Bundle/us-ph-reporting-bundle-example, Bundle/us-ph-response-bundle-example and Patient/us-ph-patient-eve-everywoman
  - expandedYes-NoIndicator: Observation/us-ph-postpartum-status-eve-everywoman and USPublicHealthIsPostpartum
- ISO Maintains the copyright on the country codes, and controls it's use carefully. For futher details see the ISO 3166 web page: https://www.iso.org/iso-3166-country-codes.html
  Show Usage
  - ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code: Bundle/us-ph-specification-bundle-example, MessageDefinition/us-ph-messagedefinition-contentbundle-example... Show 102 more, Observation/us-ph-travel-history-eve-everywoman-201801, PlanDefinitionUSPublicHealthExample, RuleFilters, USPHSupplementalLibraryExample, USPHTriggeringValueSetLibraryExample, USPHValueSetLibraryExample, USPHValueSetLibraryExpansionParametersExample, USPublicHealthAddressExtension, USPublicHealthAlternativeExpressionExtension, USPublicHealthAsyncIndicatorExtension, USPublicHealthCharacteristicsOfHomeEnvironment, USPublicHealthCodeSystem, USPublicHealthCodeSystemEndpointConnectionTypeExample, USPublicHealthCodeSystemForValueSetUseContext, USPublicHealthCodeSystemJurisdictionTypesExample, USPublicHealthCodeSystemJurisdictionsExample, USPublicHealthCodeSystemMessageTypes, USPublicHealthCodeSystemPlanDefinitionActions, USPublicHealthCodeSystemPropertyRequiredBindingExtension, USPublicHealthCodeSystemReportInitiationTypes, USPublicHealthCodeSystemTriggerDefinitionNamedEvents, USPublicHealthCodeSystemUsageContext, USPublicHealthCodeSystemUsageContextType, USPublicHealthComposition, USPublicHealthComputableLibrary, USPublicHealthComputableValueSet, USPublicHealthConditionEncounterDiagnosis, USPublicHealthConditionProblemsHealthConcerns, USPublicHealthContentBundle, USPublicHealthDataEncryptedExtension, USPublicHealthDataEncryptionAlgorithmExtension, USPublicHealthDateDeterminedExtension, USPublicHealthDateRecordedExtension, USPublicHealthDeterminationOfReportabilityExtension, USPublicHealthDeterminationOfReportabilityReasonExtension, USPublicHealthDeterminationOfReportabilityRuleExtension, USPublicHealthDisabilityStatus, USPublicHealthDocumentBundle, USPublicHealthEmergencyOutbreakInformation, USPublicHealthEncounter, USPublicHealthEndpoint, USPublicHealthExecutableLibrary, USPublicHealthExecutableValueSet, USPublicHealthExpansionParametersExtension, USPublicHealthExpectedResponseTimeExtension, USPublicHealthExposureContactInformation, USPublicHealthFHIRQueryPatternExtension, USPublicHealthInformationRecipientExtension, USPublicHealthInitiationReasonExtension, USPublicHealthInitiationTypeExtension, USPublicHealthIsPostpartum, USPublicHealthLaboratoryResultObservationProfile, USPublicHealthLocation, USPublicHealthMedicationAdministration, USPublicHealthMessageDefinition, USPublicHealthMessageHeader, USPublicHealthMessageProcessingCategoryExtension, USPublicHealthNamedEventTypeExtension, USPublicHealthOrganization, USPublicHealthPatient, USPublicHealthPlanDefinition, USPublicHealthPlanDefinitionAlternativeExpressionExample, USPublicHealthPlanDefinitionNamedEventExample, USPublicHealthPractitionerRole, USPublicHealthPregnancyOutcomeObservation, USPublicHealthPregnancyStatusObservation, USPublicHealthProfilesLibrary, USPublicHealthReceiverAddressExtension, USPublicHealthReceiverJwksUrlExtension, USPublicHealthRelatedDataExtension, USPublicHealthReportingBundle, USPublicHealthResponseBundle, USPublicHealthSpecificationBundle, USPublicHealthSpecificationLibrary, USPublicHealthSpecificationLibraryExample, USPublicHealthSupplementalLibrary, USPublicHealthSupplementalValueSet, USPublicHealthSupplementalValueSetLibraryExample, USPublicHealthSupplementalValuesetLibrary, USPublicHealthSurveyPractitionerGroup, USPublicHealthTherapeuticMedicationResponseExtension, USPublicHealthTransportationDetails, USPublicHealthTravelHistory, USPublicHealthTribalAffiliationExtension, USPublicHealthTriggeringValueSet, USPublicHealthTriggeringValueSetLibrary, USPublicHealthTrustServiceEndpointExtension, USPublicHealthUsageWarningExtension, USPublicHealthValueSet, USPublicHealthValueSetChlamydiaExample, USPublicHealthValueSetComputableExample, USPublicHealthValueSetExecutableChlamydiaExample, USPublicHealthValueSetLibrary, USPublicHealthValueSetMessageSignificanceCategory, USPublicHealthValueSetMessageTypes, USPublicHealthValueSetPlanDefinitionAction, USPublicHealthValueSetPregnancyStatus, USPublicHealthValueSetPriority, USPublicHealthValueSetReportInitiationType, USPublicHealthValueSetSupplementalExample, USPublicHealthValueSetTriggerDefinitionNamedEvent and USPublicHealthValueSetTriggeringChlamydiaExample
- Most of the information on the CDC and ATSDR websites is not subject to copyright, is in the public domain, and may be freely used or reproduced without obtaining copyright permission.</p>

  For information and exceptions regarding use of CDC material please see https://www.cdc.gov/other/agencymaterials.html.

  Show Usage
  - CDC Race and Ethnicity: Bundle/us-ph-content-bundle-example, Bundle/us-ph-document-bundle-example, Bundle/us-ph-reporting-bundle-example, Bundle/us-ph-response-bundle-example and Patient/us-ph-patient-eve-everywoman
  </li>
- The UCUM codes, UCUM table (regardless of format), and UCUM Specification are copyright 1999-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. https://ucum.org/trac/wiki/TermsOfUse
  Show Usage
  - Unified Code for Units of Measure (UCUM): MedicationAdministration/us-ph-medadmin-eve-everywoman-naloxone-response, Observation/us-ph-lab-result-eve-everywoman-lymphocytes, Observation/us-ph-lab-result-eve-everywoman-pertussis and Observation/us-ph-reportability-information-observation
- This material contains content from LOINC. LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.
  Show Usage
  - LOINC: Bundle/us-ph-document-bundle-example, Composition/us-ph-composition-example... Show 14 more, Observation/us-ph-char-home-environment-eve-everywoman, Observation/us-ph-disability-status-eve-everywoman, Observation/us-ph-lab-result-eve-everywoman-lymphocytes, Observation/us-ph-lab-result-eve-everywoman-pertussis, Observation/us-ph-pregnancy-outcome-eve-everywoman, Observation/us-ph-pregnancy-status-eve-everywoman, RuleFilters, USPublicHealthCharacteristicsOfHomeEnvironment, USPublicHealthDisabilityStatus, USPublicHealthPregnancyOutcomeObservation, USPublicHealthPregnancyStatusObservation, USPublicHealthValueSetChlamydiaExample, USPublicHealthValueSetExecutableChlamydiaExample and USPublicHealthValueSetTriggeringChlamydiaExample
- This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed or info@snomed.org.
  Show Usage
  - SNOMED Clinical Terms® (SNOMED CT®): Bundle/us-ph-document-bundle-example, City Football Stadium... Show 27 more, Condition/us-ph-condition-encounter-diagnosis-diabetes, Condition/us-ph-condition-problem-health-concern-hypertension, MedicationAdministration/us-ph-medadmin-eve-everywoman-azithromycin, MedicationAdministration/us-ph-medadmin-eve-everywoman-naloxone-response, Observation/us-ph-char-home-environment-eve-everywoman, Observation/us-ph-exposure-contact-info-football-game, Observation/us-ph-postpartum-status-eve-everywoman, Observation/us-ph-pregnancy-outcome-eve-everywoman, Observation/us-ph-pregnancy-status-eve-everywoman, Observation/us-ph-transportation-details-eve-everywoman, Observation/us-ph-travel-history-eve-everywoman-1999, Observation/us-ph-travel-history-eve-everywoman-201610, Observation/us-ph-travel-history-eve-everywoman-201801, PractitionerRole/us-ph-practitionerrole-henry-seven, USPublicHealthCharacteristicsOfHomeEnvironment, USPublicHealthInitiationReasonExtension, USPublicHealthIsPostpartum, USPublicHealthPregnancyOutcomeObservation, USPublicHealthPregnancyStatusObservation, USPublicHealthTherapeuticMedicationResponseExtension, USPublicHealthTransportationDetails, USPublicHealthTravelHistory, USPublicHealthValueSet, USPublicHealthValueSetChlamydiaExample, USPublicHealthValueSetExecutableChlamydiaExample, USPublicHealthValueSetSupplementalExample and USPublicHealthValueSetTriggeringChlamydiaExample
- Used by permission of HL7 International, all rights reserved Creative Commons License
  Show Usage
  - US Core Tags CodeSystem: USPublicHealthConditionProblemsHealthConcerns
- Using RxNorm codes of type SAB=RXNORM as this specification describes does not require a UMLS license. Access to the full set of RxNorm definitions, and/or additional use of other RxNorm structures and information requires a UMLS license. The use of RxNorm in this specification is pursuant to HL7's status as a licensee of the NLM UMLS. HL7's license does not convey the right to use RxNorm to any users of this specification; implementers must acquire a license to use RxNorm in their own right.
  Show Usage
  - RxNorm: MedicationAdministration/us-ph-medadmin-eve-everywoman-azithromycin, MedicationAdministration/us-ph-medadmin-eve-everywoman-naloxone-response and USPublicHealthMedicationAdministration
</ul>