eICR Anonymized Organization - CDC FHIR® Implementation Guide: Anonymized Electronic Initial Case Reporting (eICR) v1.0.0

CDC FHIR® Implementation Guide: Anonymized Electronic Initial Case Reporting (eICR)
1.0.0 - ci-build United States of America flag

CDC FHIR® Implementation Guide: Anonymized Electronic Initial Case Reporting (eICR), published by APHL. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/lantanagroup/FHIR-us-eicr-anonymized/ and changes regularly. See the Directory of published versions

Resource Profile: eICR Anonymized Organization

Official URL: http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-organization				Version: 1.0.0
Active as of 2024-11-13				Computable Name: EICRAnonymizedOrganization

This Organization profile represents an anonymized eCR Organization.

It is based on the US Public Health Organization profile with further constraints to require masking of name, address, and telecom.

Usage:

Refer to this Resource Profile: eICR Anonymized Past or Present Job
Examples for this Resource Profile: Organization/organization-name-tele-addr-anon

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 USPublicHealthOrganization

Name	Flags	Card.	Type	Description & Constraints
Organization			USPublicHealthOrganization
text	C	0..1	Narrative	Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	1..1	(Complex)	Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
div		1..1	xhtml	Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
name	C	1..1	string	Name used for the organization eicr-anon-org-name: Organization.name.value SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	A value for name is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
telecom	C	1..*	ContactPoint	A contact detail for the organization eicr-anon-org-tel: Organization.telecom fields SHALL NOT be present
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	1..1	(Complex)	A value is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
address	C	1..1	Address	An address for the organization eicr-anon-org-ad: Organization.address fields SHALL NOT be present
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
dataAbsentReason	S	1..1	(Complex)	A value is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Fixed Value: masked
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
eicr-anon-org-ad	error	Organization.address	Organization.address fields SHALL NOT be present : use.empty() and text.empty() and line.empty() and city.empty() and district.empty() and state.empty() and postalCode.empty() and country.empty() and period.empty()
eicr-anon-org-name	error	Organization.name	Organization.name.value SHALL NOT be present : value.empty()
eicr-anon-org-tel	error	Organization.telecom	Organization.telecom fields SHALL NOT be present : system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-text	error	Organization.text	text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s<p>MASKED</p>\\s</div>')

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	USPublicHealthOrganization	US Public Health Organization org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
text	C	0..1	Narrative	Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
status		1..1	code	generated \| extensions \| additional \| empty Binding: NarrativeStatus (required): The status of a resource narrative.
div	C	1..1	xhtml	Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
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
identifier:NPI	SΣC	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
identifier:CLIA	ΣC	0..1	Identifier	Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following
system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7
active	?!SΣ	1..1	boolean	Whether the organization's record is still in active use
name	SΣC	1..1	string	Name used for the organization eicr-anon-org-name: Organization.name.value SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	A value for name is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
telecom	SC	1..*	ContactPoint	A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' eicr-anon-org-tel: Organization.telecom fields SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	A value is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
system	SΣC	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.
address	SC	1..1	Address	An address for the organization org-2: An address of an organization can never be of use 'home' eicr-anon-org-ad: Organization.address fields SHALL NOT be present
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
dataAbsentReason	S	1..1	(Complex)	A value is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
use	?!Σ	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
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
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)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Organization.text.extension:dataAbsentReason.value[x]	required	Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
Organization.text.status	required	NarrativeStatus `http://hl7.org/fhir/ValueSet/narrative-status\|4.0.1` from the FHIR Standard
Organization.identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Organization.name.extension:dataAbsentReason.value[x]	required	Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
Organization.telecom.extension:dataAbsentReason.value[x]	required	Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
Organization.telecom.system	required	ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system\|4.0.1` from the FHIR Standard
Organization.telecom.use	required	ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use\|4.0.1` from the FHIR Standard
Organization.address.extension:dataAbsentReason.value[x]	required	Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
Organization.address.use	required	AddressUse `http://hl7.org/fhir/ValueSet/address-use\|4.0.1` from the FHIR Standard
Organization.address.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from `https://www.usps.com/`) `http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state`

Constraints

Id	Grade	Path(s)	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()
eicr-anon-org-ad	error	Organization.address	Organization.address fields SHALL NOT be present : use.empty() and text.empty() and line.empty() and city.empty() and district.empty() and state.empty() and postalCode.empty() and country.empty() and period.empty()
eicr-anon-org-name	error	Organization.name	Organization.name.value SHALL NOT be present : value.empty()
eicr-anon-org-tel	error	Organization.telecom	Organization.telecom fields SHALL NOT be present : system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-text	error	Organization.text	text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s<p>MASKED</p>\\s</div>')
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.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
org-2	error	Organization.address	An address of an organization can never be of use 'home' : where(use = 'home').empty()
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home' : where(use = 'home').empty()
txt-1	error	Organization.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks()
txt-2	error	Organization.text.div	The narrative SHALL have some non-whitespace content : htmlChecks()