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

## Resource Profile: US Public Health CodeSystem

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem | Version: 1.0.0
Active as of 2023-10-04 | Computable Name: USPublicHealthCodeSystem

This CodeSystem profile describes describes the minimum requirements for a US public health code system.

Usage:

- Examples for this Resource Profile: USPublicHealthCodeSystemEndpointConnectionTypeExample, USPublicHealthCodeSystemJurisdictionTypesExample, USPublicHealthCodeSystemJurisdictionsExample, USPublicHealthCodeSystemMessageTypes... Show 6 more, USPublicHealthCodeSystemPlanDefinitionActions, USPublicHealthCodeSystemReportInitiationTypes, USPublicHealthCodeSystemTriggerDefinitionNamedEvents, USPublicHealthCodeSystemUsageContextType, USPublicHealthCodeSystemUsageContext and USPublicHealthCodeSystemForValueSetUseContext

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from CodeSystem

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
CodeSystem |  | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement
property | S | 0..* | BackboneElement | Additional information supplied about each concept
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
binding | S | 0..1 | canonical() | What values are allowed URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem-property-required-binding-extension
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
content | Σ | 1..1 | code | not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
property | S Σ | 0..* | BackboneElement | Additional information supplied about each concept
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
binding | S | 0..1 | canonical() | What values are allowed URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem-property-required-binding-extension
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations
type | Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
CodeSystem.status | required | PublicationStatus
CodeSystem.content | required | CodeSystemContentMode
CodeSystem.property.type | required | PropertyType

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 0..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
identifier | Σ | 0..* | Identifier | Additional identifier for the code system (business identifier)
version | Σ | 0..1 | string | Business version of the code system (Coding.version)
name | Σ C | 0..1 | string | Name for this code system (computer friendly)
title | Σ | 0..1 | string | Name for this code system (human friendly)
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage
date | Σ | 0..1 | dateTime | Date last changed
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual)
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
description |  | 0..1 | markdown | Natural language description of the code system
useContext | Σ TU | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this code system is defined
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
caseSensitive | Σ | 0..1 | boolean | If code comparison is case sensitive
valueSet | Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system
hierarchyMeaning | Σ | 0..1 | code | grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.
compositional | Σ | 0..1 | boolean | If code system defines a compositional grammar
versionNeeded | Σ | 0..1 | boolean | If definitions are not stable
content | Σ | 1..1 | code | not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
supplements | Σ | 0..1 | canonical(CodeSystem) | Canonical URL of Code System this adds designations and properties to
count | Σ | 0..1 | unsignedInt | Total concepts in the code system
filter | Σ | 0..* | BackboneElement | Filter that can be used in a value set
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | code | Code that identifies the filter
description | Σ | 0..1 | string | How or why the filter is used
operator | Σ | 1..* | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
value | Σ | 1..1 | string | What to use for the value
property | S Σ | 0..* | BackboneElement | Additional information supplied about each concept
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
binding | S | 0..1 | canonical() | What values are allowed URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem-property-required-binding-extension
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations
uri | Σ | 0..1 | uri | Formal identifier for the property
description | Σ | 0..1 | string | Why the property is defined, and/or what it conveys
type | Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value.
concept |  | 0..* | BackboneElement | Concepts in the code system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | code | Code that identifies concept
display |  | 0..1 | string | Text to display to the user
definition |  | 0..1 | string | Formal definition
designation |  | 0..* | BackboneElement | Additional representations for the concept
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
use |  | 0..1 | Coding | Details how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used.
value |  | 1..1 | string | The text value for this designation
property |  | 0..* | BackboneElement | Property value for the concept
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | code | Reference to CodeSystem.property.code
value[x] |  | 1..1 |  | Value of the property for this concept
valueCode |  |  | code |
valueCoding |  |  | Coding |
valueString |  |  | string |
valueInteger |  |  | integer |
valueBoolean |  |  | boolean |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
concept |  | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
CodeSystem.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
CodeSystem.status | required | PublicationStatus
CodeSystem.jurisdiction | extensible | Jurisdiction ValueSet
CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaning
CodeSystem.content | required | CodeSystemContentMode
CodeSystem.filter.operator | required | FilterOperator
CodeSystem.property.type | required | PropertyType
CodeSystem.concept.designation.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
CodeSystem.concept.designation.use | extensible | DesignationUse

This structure is derived from CodeSystem

Summary

Must-Support: 2 elements

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem-property-required-binding-extension

Differential View

This structure is derived from CodeSystem

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
CodeSystem |  | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement
property | S | 0..* | BackboneElement | Additional information supplied about each concept
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
binding | S | 0..1 | canonical() | What values are allowed URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem-property-required-binding-extension
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
content | Σ | 1..1 | code | not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
property | S Σ | 0..* | BackboneElement | Additional information supplied about each concept
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
binding | S | 0..1 | canonical() | What values are allowed URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem-property-required-binding-extension
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations
type | Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
CodeSystem.status | required | PublicationStatus
CodeSystem.content | required | CodeSystemContentMode
CodeSystem.property.type | required | PropertyType

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
CodeSystem | C | 0..* | CodeSystem | Declares the existence of and describes a code system or code system supplement
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
url | Σ | 0..1 | uri | Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
identifier | Σ | 0..* | Identifier | Additional identifier for the code system (business identifier)
version | Σ | 0..1 | string | Business version of the code system (Coding.version)
name | Σ C | 0..1 | string | Name for this code system (computer friendly)
title | Σ | 0..1 | string | Name for this code system (human friendly)
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage
date | Σ | 0..1 | dateTime | Date last changed
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual)
contact | Σ | 0..* | ContactDetail | Contact details for the publisher
description |  | 0..1 | markdown | Natural language description of the code system
useContext | Σ TU | 0..* | UsageContext | The context that the content is intended to support
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for code system (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose |  | 0..1 | markdown | Why this code system is defined
copyright |  | 0..1 | markdown | Use and/or publishing restrictions
caseSensitive | Σ | 0..1 | boolean | If code comparison is case sensitive
valueSet | Σ | 0..1 | canonical(ValueSet) | Canonical reference to the value set with entire code system
hierarchyMeaning | Σ | 0..1 | code | grouped-by | is-a | part-of | classified-with Binding: CodeSystemHierarchyMeaning (required): The meaning of the hierarchy of concepts in a code system.
compositional | Σ | 0..1 | boolean | If code system defines a compositional grammar
versionNeeded | Σ | 0..1 | boolean | If definitions are not stable
content | Σ | 1..1 | code | not-present | example | fragment | complete | supplement Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
supplements | Σ | 0..1 | canonical(CodeSystem) | Canonical URL of Code System this adds designations and properties to
count | Σ | 0..1 | unsignedInt | Total concepts in the code system
filter | Σ | 0..* | BackboneElement | Filter that can be used in a value set
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | code | Code that identifies the filter
description | Σ | 0..1 | string | How or why the filter is used
operator | Σ | 1..* | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.
value | Σ | 1..1 | string | What to use for the value
property | S Σ | 0..* | BackboneElement | Additional information supplied about each concept
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
binding | S | 0..1 | canonical() | What values are allowed URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem-property-required-binding-extension
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | code | Identifies the property on the concepts, and when referred to in operations
uri | Σ | 0..1 | uri | Formal identifier for the property
description | Σ | 0..1 | string | Why the property is defined, and/or what it conveys
type | Σ | 1..1 | code | code | Coding | string | integer | boolean | dateTime | decimal Binding: PropertyType (required): The type of a property value.
concept |  | 0..* | BackboneElement | Concepts in the code system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | code | Code that identifies concept
display |  | 0..1 | string | Text to display to the user
definition |  | 0..1 | string | Formal definition
designation |  | 0..* | BackboneElement | Additional representations for the concept
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
language |  | 0..1 | code | Human language of the designation Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
use |  | 0..1 | Coding | Details how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used.
value |  | 1..1 | string | The text value for this designation
property |  | 0..* | BackboneElement | Property value for the concept
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 1..1 | code | Reference to CodeSystem.property.code
value[x] |  | 1..1 |  | Value of the property for this concept
valueCode |  |  | code |
valueCoding |  |  | Coding |
valueString |  |  | string |
valueInteger |  |  | integer |
valueBoolean |  |  | boolean |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
concept |  | 0..* | See concept (CodeSystem) | Child Concepts (is-a/contains/categorizes)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
CodeSystem.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
CodeSystem.status | required | PublicationStatus
CodeSystem.jurisdiction | extensible | Jurisdiction ValueSet
CodeSystem.hierarchyMeaning | required | CodeSystemHierarchyMeaning
CodeSystem.content | required | CodeSystemContentMode
CodeSystem.filter.operator | required | FilterOperator
CodeSystem.property.type | required | PropertyType
CodeSystem.concept.designation.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
CodeSystem.concept.designation.use | extensible | DesignationUse

This structure is derived from CodeSystem

Summary

Must-Support: 2 elements

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem-property-required-binding-extension

Other representations of profile: CSV, Excel, Schematron