This page is part of the US Public Health Profiles Library (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings

Resource Profile: US Public Health CodeSystem

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-codesystem				Version: 1.0.0-ballot
Active as of 2022-08-05				Computable Name: USPublicHealthCodeSystem

This profile describes the US Public Health CodeSystem.

Usage:

• Examples for this Resource Profile: USPublicHealthCodeSystemJurisdictionsExample, USPublicHealthTriggerDefinitionNamedEvents, USPPublicHealthUsageContextType, USPublicHealthUsageContext

Formal Views of Profile Content

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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
CodeSystem.language	preferred	CommonLanguages Max Binding: AllLanguages
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 Max Binding: AllLanguages
CodeSystem.concept.designation.use	extensible	DesignationUse

Constraints

Id	Grade	Path	Details	Requirements
csd-0	warning	CodeSystem	Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
csd-1	error	CodeSystem	Within a code system definition, all the codes SHALL be unique : concept.code.combine($this.descendants().concept.code).isDistinct()
dom-2	error	CodeSystem	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	CodeSystem	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	CodeSystem	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	CodeSystem	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Best Practice	CodeSystem	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	CodeSystem.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CodeSystem.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CodeSystem.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CodeSystem.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CodeSystem.url	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.version	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.title	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.experimental	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.date	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.publisher	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.contact	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.useContext	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.jurisdiction	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.purpose	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.copyright	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.caseSensitive	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.valueSet	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.hierarchyMeaning	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.compositional	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.versionNeeded	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.content	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.supplements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.count	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.filter	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.filter.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CodeSystem.filter.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CodeSystem.filter.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CodeSystem.filter.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CodeSystem.filter.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.filter.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.filter.operator	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.filter.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.property	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.property.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CodeSystem.property.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CodeSystem.property.extension:binding	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CodeSystem.property.extension:binding	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CodeSystem.property.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CodeSystem.property.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CodeSystem.property.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.property.uri	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.property.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.property.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.concept	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.concept.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CodeSystem.concept.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CodeSystem.concept.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CodeSystem.concept.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CodeSystem.concept.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.concept.display	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.concept.definition	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.concept.designation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.concept.designation.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CodeSystem.concept.designation.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CodeSystem.concept.designation.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CodeSystem.concept.designation.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CodeSystem.concept.designation.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.concept.designation.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.concept.designation.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.concept.property	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.concept.property.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CodeSystem.concept.property.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CodeSystem.concept.property.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	CodeSystem.concept.property.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	CodeSystem.concept.property.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.concept.property.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	CodeSystem.concept.concept	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())