CDC FHIR® IG: Anonymized Electronic Initial Case Reporting (eICR)
1.0.1 - release United States of America flag

CDC FHIR® IG: Anonymized Electronic Initial Case Reporting (eICR) - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. 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.1
Active as of 2025-04-14 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:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* USPublicHealthOrganization US Public Health Organization
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
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
ele-1: All FHIR elements must have a @value or children
... text C 0..1 Narrative Text summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:dataAbsentReason S 1..1 (Complex) Use data-absent-reason with value 'masked'
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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)
ele-1: All FHIR elements must have a @value or children
Fixed Value: masked
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.


ele-1: All FHIR elements must have a @value or children
.... div C 1..1 xhtml Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... 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 .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:NPI SΣC 0..1 Identifier National Provider Identifier (NPI)
ele-1: All FHIR elements must have a @value or children

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
ele-1: All FHIR elements must have a @value or children

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
ele-1: All FHIR elements must have a @value or children
... name SΣC 1..1 string Name used for the organization
ele-1: All FHIR elements must have a @value or children
eicr-anon-org-name: A value for Organization.name SHALL NOT be present
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension: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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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)
ele-1: All FHIR elements must have a @value or children
Fixed Value: masked
... telecom SC 1..* ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension: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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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)
ele-1: All FHIR elements must have a @value or children
Fixed Value: masked
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
... address SC 1..1 Address An address for the organization
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension: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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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)
ele-1: All FHIR elements must have a @value or children
Fixed Value: masked
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
.... line SΣ 0..4 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
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.
ele-1: All FHIR elements must have a @value or children
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.


ele-1: All FHIR elements must have a @value or children
.... postalCode SΣ 0..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.text.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.text.statusrequiredNarrativeStatus
http://hl7.org/fhir/ValueSet/narrative-status|4.0.1
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
eicr-anon-org-aderrorOrganization.addressOrganization.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-nameerrorOrganization.nameA value for Organization.name SHALL NOT be present
: hasValue().not()
eicr-anon-org-telerrorOrganization.telecomOrganization.telecom fields SHALL NOT be present
: system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-texterrorOrganization.texttext.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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
txt-1errorOrganization.text.divThe 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-2errorOrganization.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()

This structure is derived from USPublicHealthOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
..... extension: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: A value for Organization.name SHALL NOT be present
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension: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
..... extension: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
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension: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

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
eicr-anon-org-aderrorOrganization.addressOrganization.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-nameerrorOrganization.nameA value for Organization.name SHALL NOT be present
: hasValue().not()
eicr-anon-org-telerrorOrganization.telecomOrganization.telecom fields SHALL NOT be present
: system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-texterrorOrganization.texttext.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>')
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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
... 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>'
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:dataAbsentReason S 1..1 (Complex) Use data-absent-reason with value 'masked'
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... id 0..1 id Unique id for inter-element referencing
...... 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
... 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ΣC 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
..... 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ΣC 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 ΣC 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ΣC 1..1 string Name used for the organization
eicr-anon-org-name: A value for Organization.name SHALL NOT be present
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension: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
...... id 0..1 id Unique id for inter-element referencing
...... 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
.... value 0..1 string Primitive value for string
Max Length:1048576
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... 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
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension: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
...... id 0..1 id Unique id for inter-element referencing
...... 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.

.... 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 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
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension: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
...... id 0..1 id Unique id for inter-element referencing
...... 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
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.text.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.text.statusrequiredNarrativeStatus
http://hl7.org/fhir/ValueSet/narrative-status|4.0.1
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
eicr-anon-org-aderrorOrganization.addressOrganization.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-nameerrorOrganization.nameA value for Organization.name SHALL NOT be present
: hasValue().not()
eicr-anon-org-telerrorOrganization.telecomOrganization.telecom fields SHALL NOT be present
: system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-texterrorOrganization.texttext.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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
txt-1errorOrganization.text.divThe 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-2errorOrganization.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()

This structure is derived from USPublicHealthOrganization

Summary

Mandatory: 6 elements(2 nested mandatory elements)
Must-Support: 4 elements
Fixed: 4 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* USPublicHealthOrganization US Public Health Organization
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
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
ele-1: All FHIR elements must have a @value or children
... text C 0..1 Narrative Text summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension:dataAbsentReason S 1..1 (Complex) Use data-absent-reason with value 'masked'
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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)
ele-1: All FHIR elements must have a @value or children
Fixed Value: masked
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.


ele-1: All FHIR elements must have a @value or children
.... div C 1..1 xhtml Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... 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 .


ele-1: All FHIR elements must have a @value or children
..... system SΣ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:NPI SΣC 0..1 Identifier National Provider Identifier (NPI)
ele-1: All FHIR elements must have a @value or children

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
ele-1: All FHIR elements must have a @value or children

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
ele-1: All FHIR elements must have a @value or children
... name SΣC 1..1 string Name used for the organization
ele-1: All FHIR elements must have a @value or children
eicr-anon-org-name: A value for Organization.name SHALL NOT be present
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension: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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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)
ele-1: All FHIR elements must have a @value or children
Fixed Value: masked
... telecom SC 1..* ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension: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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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)
ele-1: All FHIR elements must have a @value or children
Fixed Value: masked
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
... address SC 1..1 Address An address for the organization
ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension: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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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)
ele-1: All FHIR elements must have a @value or children
Fixed Value: masked
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
.... line SΣ 0..4 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
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.
ele-1: All FHIR elements must have a @value or children
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.


ele-1: All FHIR elements must have a @value or children
.... postalCode SΣ 0..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.text.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.text.statusrequiredNarrativeStatus
http://hl7.org/fhir/ValueSet/narrative-status|4.0.1
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
eicr-anon-org-aderrorOrganization.addressOrganization.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-nameerrorOrganization.nameA value for Organization.name SHALL NOT be present
: hasValue().not()
eicr-anon-org-telerrorOrganization.telecomOrganization.telecom fields SHALL NOT be present
: system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-texterrorOrganization.texttext.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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
txt-1errorOrganization.text.divThe 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-2errorOrganization.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()

Differential View

This structure is derived from USPublicHealthOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
..... extension: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: A value for Organization.name SHALL NOT be present
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension: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
..... extension: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
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension: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

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
eicr-anon-org-aderrorOrganization.addressOrganization.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-nameerrorOrganization.nameA value for Organization.name SHALL NOT be present
: hasValue().not()
eicr-anon-org-telerrorOrganization.telecomOrganization.telecom fields SHALL NOT be present
: system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-texterrorOrganization.texttext.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>')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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
... 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>'
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:dataAbsentReason S 1..1 (Complex) Use data-absent-reason with value 'masked'
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
...... id 0..1 id Unique id for inter-element referencing
...... 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
... 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ΣC 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
..... 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ΣC 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 ΣC 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ΣC 1..1 string Name used for the organization
eicr-anon-org-name: A value for Organization.name SHALL NOT be present
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension: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
...... id 0..1 id Unique id for inter-element referencing
...... 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
.... value 0..1 string Primitive value for string
Max Length:1048576
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... 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
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension: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
...... id 0..1 id Unique id for inter-element referencing
...... 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.

.... 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 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
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension: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
...... id 0..1 id Unique id for inter-element referencing
...... 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
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.text.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.text.statusrequiredNarrativeStatus
http://hl7.org/fhir/ValueSet/narrative-status|4.0.1
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
eicr-anon-org-aderrorOrganization.addressOrganization.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-nameerrorOrganization.nameA value for Organization.name SHALL NOT be present
: hasValue().not()
eicr-anon-org-telerrorOrganization.telecomOrganization.telecom fields SHALL NOT be present
: system.empty() and value.empty() and use.empty() and rank.empty() and period.empty()
eicr-anon-texterrorOrganization.texttext.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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
txt-1errorOrganization.text.divThe 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-2errorOrganization.text.divThe narrative SHALL have some non-whitespace content
: htmlChecks()

This structure is derived from USPublicHealthOrganization

Summary

Mandatory: 6 elements(2 nested mandatory elements)
Must-Support: 4 elements
Fixed: 4 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron