HL7.FHIR.US.ECR\US Public Health Organization

HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.0.0 - STU 2

This page is part of the electronic Case Reporting (eCR) (v2.0.0: STU 2 on FHIR R4) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: US Public Health Organization

Defining URL:

http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-organization

Version:

2.0.0

Name:

USPublicHealthOrganization

Title:

US Public Health Organization

Status:

Active as of 1/18/22 12:57 PM

Definition:

This Organization profile represents an organization involved in public health. It is based on the US Core Organization profile and establishes the core elements, extensions, vocabularies and value sets for representing organizations for public health.

Publisher:

HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm)

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-organization

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 2 elements
Must-Support: 2 elements

This structure is derived from USCoreOrganizationProfile

Name	Flags	Card.	Type	Description & Constraints
Organization		0..*	USCoreOrganizationProfile	US Public Health Organization
telecom	S	1..*	ContactPoint	A contact detail for the organization
address	S	1..1	Address	An address for the organization
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Organization	I	0..*	USCoreOrganizationProfile	US Public Health Organization
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
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
Slices for identifier	SΣI	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:NPI	SΣI	0..1	Identifier	National Provider Identifier (NPI) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:CLIA	ΣI	0..1	Identifier	Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether the organization's record is still in active use
type	Σ	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
name	SΣI	1..1	string	Name used for the organization
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SI	1..*	ContactPoint	A contact detail for the organization
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣI	0..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
address	SI	1..1	Address	An address for the organization
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..4	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact		0..*	BackboneElement	Contact for the organization for a certain purpose
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
purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Organization	I	0..*	USCoreOrganizationProfile	US Public Health Organization
Slices for identifier	ΣI	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices				Content/Rules for all slices
system	Σ	0..1	uri	The namespace for the identifier value
value	Σ	0..1	string	The value that is unique
identifier:NPI	ΣI	0..1	Identifier	National Provider Identifier (NPI) Required Pattern: At least the following
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
active	?!Σ	1..1	boolean	Whether the organization's record is still in active use
name	ΣI	1..1	string	Name used for the organization
telecom	I	1..*	ContactPoint	A contact detail for the organization
system	ΣI	0..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
address	I	1..1	Address	An address for the organization
line	Σ	0..4	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label
city	Σ	0..1	string	Name of city, town etc.
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode	Σ	0..1	string	US Zip Codes
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Differential View

This structure is derived from USCoreOrganizationProfile

Name	Flags	Card.	Type	Description & Constraints
Organization		0..*	USCoreOrganizationProfile	US Public Health Organization
telecom	S	1..*	ContactPoint	A contact detail for the organization
address	S	1..1	Address	An address for the organization
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Organization	I	0..*	USCoreOrganizationProfile	US Public Health Organization
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
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
Slices for identifier	SΣI	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:NPI	SΣI	0..1	Identifier	National Provider Identifier (NPI) Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:CLIA	ΣI	0..1	Identifier	Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether the organization's record is still in active use
type	Σ	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
name	SΣI	1..1	string	Name used for the organization
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SI	1..*	ContactPoint	A contact detail for the organization
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣI	0..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
address	SI	1..1	Address	An address for the organization
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..4	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact		0..*	BackboneElement	Contact for the organization for a certain purpose
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
purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
Organization.language	preferred	CommonLanguages Max Binding: AllLanguages
Organization.identifier.use	required	IdentifierUse
Organization.identifier.type	extensible	Identifier Type Codes
Organization.type	example	OrganizationType
Organization.telecom.system	required	ContactPointSystem
Organization.telecom.use	required	ContactPointUse
Organization.address.use	required	AddressUse
Organization.address.type	required	AddressType
Organization.address.state	extensible	UspsTwoLetterAlphabeticCodes
Organization.contact.purpose	extensible	ContactEntityType

Constraints

Id	Grade	Path	Details	Requirements
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Organization	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	Organization	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	Organization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Best Practice	Organization	A resource should have narrative for robust management : text.`div`.exists()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0
ele-1	error	Organization.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Organization.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Organization.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Organization.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Organization.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.identifier.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Organization.identifier.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Organization.identifier.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.identifier.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.identifier.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.identifier.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.identifier.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.identifier.assigner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.identifier:NPI	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.identifier:CLIA	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.active	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.alias	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()
ele-1	error	Organization.telecom.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Organization.telecom.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Organization.telecom.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.telecom.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.telecom.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.telecom.rank	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.telecom.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
org-2	error	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
ele-1	error	Organization.address.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Organization.address.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Organization.address.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.address.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.address.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.address.line	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.address.city	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.address.district	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.address.state	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.address.postalCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.address.country	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.address.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.partOf	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.contact	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.contact.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Organization.contact.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Organization.contact.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	Organization.contact.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	error	Organization.contact.purpose	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.contact.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.contact.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.contact.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	error	Organization.endpoint	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2020+ HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm). Package hl7.fhir.us.ecr#2.0.0 based on FHIR 4.0.1. Generated 2022-01-18
Links: Table of Contents | QA Report | Version History | Search | | Propose a change