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

## Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

### Profiles: Content

The set of Profiles: Content is composed of profiles defining what data is exchanged about health encounters, clinical findings, clinical history, and related concepts.

US Public Health Characteristics of Home Environment | This Observation profile represents characteristics of the patient’s home environment.
US Public Health Composition | This Composition profile represents a public health composition.
US Public Health Condition Encounter Diagnosis | This Condition profile represents an encounter diagnosis for a public health event.
US Public Health Condition Problems and Health Concerns | This Condition profile represents a sign, symptom, or diagnosis for a problem or health concern related to a public health event.
US Public Health Disability Status | This Observation profile represents the Disability Element defined in the Office of the Assistant Secretary for Planning and Evaluation (ASPE) webpage HHS Implementation Guidance on Data Collection Standards for Race, Ethnicity, Sex, Primary Language, and Disability Status.
US Public Health Emergency Outbreak Information | This Observation profile represents information that is required during a public health emergency/outbreak. This information can be highly variable, so a generic structure has been chosen to represent it.
US Public Health Encounter | This Encounter profile represents the encounter related to a public health event
US Public Health Exposure Contact Information | This Observation profile represents potential patient exposure and contact information.
US Public Health Is Postpartum | This Observation profile represents whether or not the patient is postpartum.
US Public Health Laboratory Result Observation Profile | This Observation profile represents laboratory result observations related to a public health event.
US Public Health MedicationAdministration | This MedicationAdministration profile represents the event of a patient consuming or otherwise being administered a medication.
US Public Health PlanDefinition | This PlanDefinition profile describes the US Public Health PlanDefinition.
US Public Health Pregnancy Outcome Observation | This Observation profile represents a result of the pregnancy such as live birth, still birth, miscarriage, etc.
US Public Health Pregnancy Status Observation | This Observation profile represents current and/or prior pregnancy statuses and their date ranges, enabling investigators to determine if a patient was pregnant, possibly pregnant, not pregnant or whether the pregnancy status was unknown during a particular date range.
US Public Health Transportation Details | This Observation profile represents transportation details such as the type of transport (plane, train, ship, etc.) along with any associated information (e.g. name of cruise ship, flight number, airport, seat number, cabin number, etc.).
US Public Health Travel History | This Observation profile represents a patient’s travel history.

### Profiles: Content - Entities

The set of Profiles: Content - Entities is composed of profiles defining what data is exchanged about entities such as people, places, and organizations.

US Public Health Location | This Location profile represents the location/facility in which care was provided.
US Public Health Organization | This Organization profile represents an organization involved in public health.
US Public Health Patient | This Patient profile represents a US Public Health Patient.
US Public Health PractitionerRole | This PractitionerRole profile represents the roles and organizations of the practitioner.
US Public Health Survey Practitioner Group | This Group profile represents survey participant groups, research groups, etc.

### Profiles: Content - Extensions

The set of Profiles: Content - Extension is composed of Extensions defining what data about entities is exchanged.

US Public Health Address Extension | This Extension profile represents where the patient traveled to or visited as an address e.g.: country, state, city, street address (if applicable).
US Public Health Date Determined Extension | This Extension profile represents the date a status or observation was determined (date of determination).
US Public Health Date Recorded Extension | This Extension profile represents the date a status or observation was recorded (recorded date).
US Public Health Determination of Reportability Extension | This Extension profile represents the determination of reportability. Reportability is “the quality or state of being reportable or not”. Reportability does not equate to the patient having a condition or meeting a case definition (definitively being a case).
US Public Health Determination of Reportability Reason Extension | This Extension profile represents the reason for the determination of reportability.
US Public Health Determination of Reportability Rule Extension | This Extension profile represents a rule that led to the determination of reportability.
US Public Health Information Recipient Extension | This Extension profile represents an intended recipient of a US Public Health Composition.
US Public Health Initiation Reason Extension | This Extension profile contains an explanation for the manual or alternate initiation of the public health report.
US Public Health Initiation Type Extension | This Extension profile represents whether the report was either manually initiated or alternately initiated by the provider.
US Public Health Receiver Address Extension | This Extension profile indicates the endpoint address where the report is to be sent.
US Public Health Therapeutic Medication Response Extension | This Extension profile represents a therapeutic response (as opposed to an undesired reaction) to the administration of a medication.
US Public Health Tribal Affiliation Extension | This Extension profile represents an affiliated tribe name and whether or not the patient is an enrolled member of that tribe.

### Profiles: Architecture

The set of Profiles: Architecture is composed of profiles that are related to how data is defined and exchanged. These profiles support representation and use of metadata to support consistent content lifecycle management.

US Public Health Content Bundle | This Bundle profile organizes the content of the public health message to be exchanged with a public health agency.
US Public Health Content Bundle - Eve Everywoman | US Public Health Content Bundle: Eve Everywoman example
US Public Health Document Bundle | This Bundle profile represents a public health Document Bundle. It contains a US Public Health Composition.
US Public Health Endpoint | This Endpoint profile indicates where the report is to be sent.
US Public Health Endpoint - Public Health Agency | US Public Health Endpoint: Public Health Agency example
US Public Health FHIR Query Pattern Extension | This Exension profile supports communicating the FHIR query for a given data requirement.
US Public Health MessageDefinition | This MessageDefinition profile represents the characteristics of a message that can be shared in public health.
US Public Health MessageHeader | This MessageHeader profile represents the header for transmitting content using FHIR messaging.
US Public Health Reporting Bundle | This Bundle profile is used for exchanging a public health report to be submitted to a public health agency.
US Public Health Response Bundle | This Bundle profile represents the packaging construct used for exchanging a public health response.
US Public Health Specification Bundle | This Bundle profile represent the packaging construct used for exchanging a knowledge artifact.

### Profiles: Architecture - Extensions

The set of Profiles: Architecture - Extensions is composed of Extension profiles that are related to how data is defined and exchanged.

US Public Health Alternative Expression Extension | This Extension profile represents a US Public Health Alternative Expression.
US Public Health Async Indicator Extension | This Extension profile represents the expectation of whether messages resulting from the PlanDefinition are expected to be processed asynchronously.
US Public Health Data Encrypted Extension | This Exension profile indicates whether or not the data in the content bundle is encrypted.
US Public Health Data Encryption Algorithm Extension | This Extension profile represents algorithms that would be acceptable for encryption of the data prior to submitting to the data receiver.
US Public Health Expansion Parameters Extension | Thes Extension profile supports the definition of expansion parameters for the ValueSet.
US Public Health Expected Response Time Extension | This Extension profile represents the maximum time the sender has to wait to get a response, beyond which the message is assumed to have failed to reach the destination.
US Public Health Message Processing Category Extension | This Extension profile indicates how systems have to deal with messages in terms of duplicates, lack of responses.
US Public Health Named Event Type Extension | This Extension profile indicates the types of named events to subscribe to from the EHR.
US Public Health Receiver JWKS Url Extension | This Extension profile indicates the location of the public key that needs to be used for encryption when sending data to the receiver.
US Public Health Related Data Extension | The Extension profile allows indicating that an input to a parent action is an input to specific child actions. It also allows the output of one action to be identified as the input to a different action.
US Public Health Trust Service Endpoint Extension | This Extension profile represents the endpoint address which implements trust services and can be used by specific actions requiring trust services with appropriate authorities and policies.
US Public Health Usage Warning Extension | This Extension profile represents an extra warning about the correct use of the value set.

### Profiles: Architecture - Terminology

The set of Profiles: Architecture - Terminolgy is composed of terminology profiles that are related to how data is defined and exchanged. These profiles support representation and use of metadata to address terminology concerns and support consistent content lifecycle management.

#### ValueSet Profiles

- The US Public Health ValueSet defines minimum base conformance requirements for a ValueSet used in public health.
- The US Public Health Triggering ValueSet defines conformance requirements for a ValueSet that is part of determination of a potentially reportable event (i.e. a &quot;triggering&quot; event).
- The US Public Health Computable ValueSet defines conformance requirements for a ValueSet that includes the computable definition of that value set, but not necessarily the full expansion. A computable value set is intended for use in environments that have access to a terminology server capable of expanding the value set.
- The US Public Health Executable ValueSet defines conformance requirements for a ValueSet that includes the complete expansion of the ValueSet, but not necessarily the computable definition. An executable value set is intended for use in environments that are not expected to have access to a terminology server capable of expanding the value set, so the expansion is communicated as part of the ValueSet. Note that a given ValueSet may conform to both the computable and executable profiles at the same time.

  #### Library Profiles

- The US Public Health Specification Library defines conformance requirements for a public health reporting program specification, typically consisting of a ValueSet library and other supporting specifications such as PlanDefinitions.
- The US Public Health Triggering ValueSet Library defines conformance requirements for a collection of ValueSets that are all used to facilitate determination of a potentially reportable event (i.e. a &quot;triggering&quot; event).
- The US Public Health Supplemental Library defines conformance requirements for the computable supplement for a public health reporting program specification, including computable routing rules that can be evaluated to help facilitate reportability determination at reporting sites, typically consisting of Clinical Quality Language (CQL) Rule libraries and additional terminiology artifacts required to evaluate those rules.
- The US Public Health Computable Library defines conformance requirements for a Library that contains CQL text, but not necessarily the compiled Expression Logical Model (ELM) for that CQL. It is intended to be used in environments that are capable of translating CQL to the executable ELM.
- The US Public Health Executable Library defines conformance requirements for a Library that contains compiled ELM, but not necessarily the source CQL text for that ELM. It is intended to be used in environments that are capable of executing ELM, but not necessarily of translating the source CQL. Note that a given Library may conform to both the computable and executable profiles at the same time.

US Public Health CodeSystem | This CodeSystem profile describes describes the minimum requirements for a US public health code system.
US Public Health CodeSystem Property Required Binding Extension | This Extension profile represents a reference to a ValueSet that establishes a required binding to the allowable values for a code system property.
US Public Health Computable Library | This Library profile defines the Library that contains Clinical Quality Language (CQL) text, but not necessarily the compiled Expression Logical Model (ELM) for that CQL. It is intended to be used in environments that are capable of translating CQL to the executable ELM.
US Public Health Computable ValueSet | This ValueSet profile describes the requirements for a value set that includes the computable definition of that value set, but not necessarily the full expansion. A computable value set is intended for use in environments that have access to a terminology server capable of expanding the value set.
US Public Health Executable Library | This Library profile defines the Library that contains compiled Expression Logical Model (ELM), but not necessarily the source Clinical Quality Language (CQL) text for that ELM. It is intended to be used in environments that are capable of executing ELM, but not necessarily of translating the source CQL.
US Public Health Executable ValueSet | This ValueSet profile describes the requirements for a value set containing a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. The complete expansion of the ValueSet is included, but not necessarily the computable definition. An executable value set is intended for use in environments that are not expected to have access to a terminology server capable of expanding the value set, so the expansion is communicated as part of the ValueSet.
US Public Health Specification Library | This Library profile defines the asset-collection library for a public health reporting program specification, typically consisting of a ValueSet library and other supporting specifications such as PlanDefinitions.
US Public Health Supplemental Library | This Library profile defines the asset-collection library containing US public health supplemental assets.
US Public Health Supplemental ValueSet | This ValueSet profile describes the requirements for a value set used when determining whether an event is suspected to be reportable.
US Public Health Supplemental ValueSet Library | This Library profile defines the library that is a computable supplement for a public health reporting program specification, including computable routing rules that can be evaluated to help facilitate reportability determination at reporting sites, typically consisting of Clinical Quality Language (CQL) Rule libraries and additional terminiology artifacts required to evaluate those rules.
US Public Health Triggering ValueSet | This ValueSet profile describes the requirements for a value set that is part of determination of a potentially reportable event (i.e. a “triggering” event).
US Public Health Triggering ValueSet Library | This Library profile defines the library containing a collection of ValueSets that are used to facilitate determination of a potentially reportable event (i.e. a “triggering” event).dd
US Public Health ValueSet | This ValueSet profile describes the minimum requirements for US public health value sets.
US Public Health ValueSet Library | This Library profile defines the library containing US Public Health value sets.

### Examples: Content

These are example instances of the Content profiles that show what data produced and consumed by systems conforming with the profiles in this library might look like.

US Public Health Characteristics of Home Environment - Eve Everywoman | US Public Health Characteristics of Home Environment: Eve Everywoman example
US Public Health Composition - Eve Everywoman | US Public Health Composition: Eve Everywoman example
US Public Health Condition Encounter Diagnosis - Eve Everywoman - Diabetes | US Public Health Condition Encounter Diagnosis: Eve Everywoman - Diabetes example
US Public Health Condition Problem Health Concern - Eve Everywoman - Hypertension | US Public Health Condition Problem Health Concern: Eve Everywoman - Hypertension example
US Public Health Disability Status - Eve Everywoman | US Public Health Disability Status: Eve Everywoman example
US Public Health Emergency Outbreak Information - Eve Everywoman | US Public Health Emergency Outbreak Information: Eve Everywoman example
US Public Health Encounter - Eve Everywoman | US Public Health Encounter: Eve Everywoman example
US Public Health Endpoint - Salem Medical Center | US Public Health Endpoint: Salem Medical Center example
US Public Health Endpoint - YMCA | US Public Health Endpoint: YMCA example
US Public Health Exposure Contact Information - Football Game | US Public Health Exposure Contact Information: Football Game example
US Public Health Is Postpartum - Eve Everywoman | US Public Health Is Postpartum: Eve Everywoman example
US Public Health Laboratory Result - Eve Everywoman - Lymphocytes | US Public Health Laboratory Result: Eve Everywoman - Lymphocytes example
US Public Health Laboratory Result - Eve Everywoman - Pertussis | US Public Health Laboratory Result: Eve Everywoman - Pertussis example
US Public Health MedicationAdministration - Eve Everywoman - Azithromycin | US Public Health MedicationAdministration: Eve Everywoman Azithromycin example
US Public Health MedicationAdministration - Eve Everywoman - Naloxone | US Public Health MedicationAdministration: Eve Everywoman - Naloxone example
US Public Health PlanDefinition - NamedEvent | US Public Health PlanDefinition: NamedEvent example
US Public Health PlanDefinition - Workflow Definition | US Public Health PlanDefinition: Workflow Definition example
US Public Health Pregnancy Outcome - Eve Everywoman | US Public Health Pregnancy Outcome: Eve Everywoman example
US Public Health Pregnancy Status - Eve Everywoman | US Public Health Pregnancy Status: Eve Everywoman example
US Public Health Reportability Information Observation - Condition Reportable | US Public Health Reportability Information Observation: Condition Reportable example
US Public Health Transportation Details - Eve Everywoman | US Public Health Transportation Details: Eve Everywoman example
US Public Health Travel History - Eve Everywoman 1999 | US Public Health Travel History: Eve Everywoman 1999 example
US Public Health Travel History - Eve Everywoman 201610 | US Public Health Travel History: Eve Everywoman 201610 example
US Public Health Travel History - Eve Everywoman 201801 | US Public Health Travel History: Eve Everywoman 201801 example

### Examples: Content - Entities

These are example instances of the Content: Entities profiles that show what data produced and consumed by systems conforming with the profiles in this library might look like.

Device - Software YMCA | Device: Software YMCA example
US Core Location - City Football Stadium | US Core Location: City Football Stadium example
US Core Practitioner - Henry Seven | US Core Practitioner: Henry Seven example
US Public Health Location - Clinic Bldg A, Salem Medical Center | US Public Health Location: Clinic Bldg A, Salem Medical Center example
US Public Health Organization - Acme Labs | US Public Health Organization: Acme Labs example
US Public Health Organization - Health Authority West | US Public Health Organization: Health Authority West example
US Public Health Organization - Salem Medical Center | US Public Health Organization: Salem Medical Center example
US Public Health Organization - YMCA | US Public Health Organization: YMCA example
US Public Health Patient - Eve Everywoman | US Public Health Patient: Eve Everywoman example
US Public Health PractitionerRole - Henry Seven | US Public Health PractitionerRole: Henry Seven example
US Public Health Survey Practitioner Group - Practitioner in Survey | US Public Health Survey Practitioner Group: Practitioner in Survey example

### Examples: Architecture

These are example instances of the Architecture profiles that show what data produced and consumed by systems conforming with the profiles in this library might look like.

US Public Health Document Bundle - Eve Everywoman | US Public Health Document Bundle: Eve Everywoman example
US Public Health MessageDefinition - Cancer Report | US Public Health MessageDefinition: Cancer Report example
US Public Health MessageHeader - Cancer Report | US Public Health MessageHeader: Cancer Report example
US Public Health MessageHeader - Case Report | US Public Health MessageHeader: Case Report example
US Public Health PlanDefinition - Alternative Expression | US Public Health PlanDefinition: Alternative Expression example
US Public Health Reporting Bundle - Eve Everywoman | US Public Health Reporting Bundle: Eve Everywoman example
US Public Health Response Bundle - Eve Everywoman | US Public Health Response Bundle: Eve Everywoman example
US Public Health Specification Bundle - Cancer Reporting | US Public Health Specification Bundle: Cancer Reporting example

### Examples: Terminology

These are example instances of the Terminologies profiles that show what data produced and consumed by systems conforming with the profiles in this library might look like.

US Public Health CodeSystem - Endpoint Connection Type Example | This code system contains codes that identify the HL7 FHIR File type.
US Public Health CodeSystem - Jurisdiction Types Example | This example code system describes the possible types of jurisdictions that require public health reporting.
US Public Health CodeSystem Jurisdictions Example | This code system describes example jurisdictions.
US Public Health Executable Library - Rule Filters - Chlamydia Example | US Public Health Executable Library example: Rule Filters - Chlamydia
US Public Health Supplemental Library Example | Description of library
US Public Health Triggering ValueSet Library Example | US Public Health Triggering ValueSet Library example
US Public Health ValueSet - Chlamydia Example | This example set of values contains laboratory observation test names that represent Chlamydia tests.
US Public Health ValueSet - Computable Example | ACME Codes for Cholesterol: Plasma only
US Public Health ValueSet Executable - Chlamydia Example | This example set of values contains laboratory observations test names that represent that the patient may have the potentially reportable condition of Chlamydia regardless of the clinical presentation of the condition
US Public Health ValueSet Library Example | US Public Health ValueSet Library example containing a Chlamydia value set
US Public Health ValueSet Library Expansion Parameters - Chlamydia Example | US Public Health ValueSet Library Expansion Parameters example containing a Chlamydia value set and demonstrating expansion parameter
US Public Health VaueSet - Supplemental Example | This valueset is a valueset created for the purposes of demonstrating, by example, the US Public Health Supplemental ValueSet profile.
US Public Health VaueSet - Triggering Chlamydia Example | This example set of values contains laboratory observations test names that represent that the patient may have the potentially reportable condition of Chlamydia regardless of the clinical presentation of the condition.

### Code Systems

These are CodeSystems defined in this profiles library.

US Public Health CodeSystem - Message Types | The US Public Health Message Types CodeSystem contains codes for currently identified use cases for identifying types of messages being exchanged. As further use cases are identified, codes may be added to the code system.
US Public Health CodeSystem - PlanDefinition Actions | The US Public Health PlanDefinition Actions CodeSystem contains codes for currently identified use cases for identifying actions in PlanDefinition.
US Public Health CodeSystem - Report Initiation Type Codes | Thsis CodeSystem contains codes for currently identified use cases for identifying how the message was initiated.
US Public Health CodeSystem - Trigger Definition Named Events | The US Public Health TriggerDefinition NamedEvents CodeSystem contains codes for currently identified use cases for identifying named events to subscribe to in clinical workflows.
US Public Health CodeSystem - Usage Context | This code system contains codes that identify the use context of a ValueSet or Library.
US Public Health CodeSystem - Usage Context Type | This code system contains codes that identify the use context type of a ValueSet or Library.
US Public Health CodeSystem for ValueSet Use Context | The US Public Health UseContext CodeSystem contains codes for currently identified use cases for representing the use context of a ValueSet.

### Value Sets

These are ValueSets defined in this profiles library.

US Public Health ValueSet - Message Significance Category | The impact of the content of a message.
US Public Health ValueSet - Report Initiation Type | The US Public Health Message Types Value Set contains codes for currently identified use cases to indicate how a messages was initiated within the health care organization.
US Public Health ValueSet Priority | This value set contains codes representing release priority for ValueSets.
US Public Health VaueSet - Message Types | The US Public Health Message Types Value Set contains codes for currently identified use cases for uniquely identifying messages in MessageHeader instances contained within a reporting bundle.
US Public Health VaueSet - PlanDefinition Action | The US Public Health PlanDefinition Action Value Set contains codes for currently identified use cases for uniquely identifying actions in PlanDefinition instances.
US Public Health VaueSet - Pregnancy Status | This value set contains codes representing pregnancy statuses.
US Public Health VaueSet - TriggerDefinition NamedEvent | The US Public Health TriggerDefinition NamedEvent Value Set contains codes for currently identified use cases for identifying named events uniquely in TriggerDefinition instances contained within a PlanDefinition.

### Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

US Public Health Specification Library Example | Description of library
US Public Health Supplemental ValueSet Library Example | Description of library

### Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

Parameters - SNOMED US Version | Parameters - SNOMED US Version