haau3 FHIR Implementation Guide (HFIG)
1.0.0 - ci-build United States of America flag

haau3 FHIR Implementation Guide (HFIG) - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: haau3 Organization

Official URL: https://haau3.com/fhir/StructureDefinition/haau3-organization Version: 1.0.0
Draft as of 2026-10-14 Computable Name: Haau3Organization

The organization for a care recipient.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* USCoreOrganizationProfile(6.1.0) A grouping of people or organizations with a common purpose
Constraints: org-1
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element must be supported. This element is included in summaries. C 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Organization.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..* Identifier National Provider Identifier (NPI)
Constraints: us-core-16, us-core-17

Required Pattern: At least the following
Organization.Slices for identifier.identifier:NPI.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:NPI.extension 0..* Extension Additional content defined by implementations
Organization.Slices for identifier.identifier:NPI.use 0..1 code usual | official | temp | secondary | old (If known)
Organization.Slices for identifier.identifier:NPI.type 0..1 CodeableConcept Description of identifier
Organization.Slices for identifier.identifier:NPI.system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
Organization.Slices for identifier.identifier:NPI.value 0..1 string The value that is unique
Organization.Slices for identifier.identifier:NPI.period 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:NPI.assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:CLIA This element is included in summaries. C 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Constraints: us-core-18

Required Pattern: At least the following
Organization.Slices for identifier.identifier:CLIA.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:CLIA.extension 0..* Extension Additional content defined by implementations
Organization.Slices for identifier.identifier:CLIA.use 0..1 code usual | official | temp | secondary | old (If known)
Organization.Slices for identifier.identifier:CLIA.type 0..1 CodeableConcept Description of identifier
Organization.Slices for identifier.identifier:CLIA.system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
Organization.Slices for identifier.identifier:CLIA.value 0..1 string The value that is unique
Organization.Slices for identifier.identifier:CLIA.period 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:CLIA.assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NAIC This element is included in summaries. C 0..* Identifier NAIC Code
Constraints: us-core-19

Required Pattern: At least the following
Organization.Slices for identifier.identifier:NAIC.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:NAIC.extension 0..* Extension Additional content defined by implementations
Organization.Slices for identifier.identifier:NAIC.use 0..1 code usual | official | temp | secondary | old (If known)
Organization.Slices for identifier.identifier:NAIC.type 0..1 CodeableConcept Description of identifier
Organization.Slices for identifier.identifier:NAIC.system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.6.300
Organization.Slices for identifier.identifier:NAIC.value 0..1 string The value that is unique
Organization.Slices for identifier.identifier:NAIC.period 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:NAIC.assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
Organization.telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
Organization.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Organization.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.address This element must be supported. C 0..* Address An address for the organization
Constraints: org-2
Organization.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.address.line This element must be supported. This element is included in summaries. 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
Organization.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Organization.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Organization.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
Organization.address.​state Base extensible USPS Two Letter Alphabetic Codes 📦6.1.0 US Core v6.1

Constraints

Id Grade Path(s) Description Expression
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()
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()
us-core-16 error Organization.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
us-core-17 error Organization.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
us-core-18 error Organization.identifier:CLIA CLIA number must be 10 digits with a letter "D" in third position value.matches('^[0-9]{2}D[0-9]{7}$')
us-core-19 error Organization.identifier:NAIC NAIC must be 5 digits value.matches('^[0-9]{5}$')

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization 0..* USCoreOrganizationProfile(6.1.0) A grouping of people or organizations with a common purpose

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* USCoreOrganizationProfile(6.1.0) A grouping of people or organizations with a common purpose
Constraints: org-1
Organization.id This element is included in summaries. 0..1 id Logical id of this artifact
Organization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Organization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Organization.contained 0..* Resource Contained, inline Resources
Organization.extension 0..* Extension Additional content defined by implementations
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element must be supported. This element is included in summaries. C 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:All Slices.type This element is included in summaries. 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.
Organization.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Organization.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..* Identifier National Provider Identifier (NPI)
Constraints: us-core-16, us-core-17

Required Pattern: At least the following
Organization.Slices for identifier.identifier:NPI.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:NPI.extension 0..* Extension Additional content defined by implementations
Organization.Slices for identifier.identifier:NPI.use 0..1 code usual | official | temp | secondary | old (If known)
Organization.Slices for identifier.identifier:NPI.type 0..1 CodeableConcept Description of identifier
Organization.Slices for identifier.identifier:NPI.system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
Organization.Slices for identifier.identifier:NPI.value 0..1 string The value that is unique
Organization.Slices for identifier.identifier:NPI.period 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:NPI.assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:CLIA This element is included in summaries. C 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Constraints: us-core-18

Required Pattern: At least the following
Organization.Slices for identifier.identifier:CLIA.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:CLIA.extension 0..* Extension Additional content defined by implementations
Organization.Slices for identifier.identifier:CLIA.use 0..1 code usual | official | temp | secondary | old (If known)
Organization.Slices for identifier.identifier:CLIA.type 0..1 CodeableConcept Description of identifier
Organization.Slices for identifier.identifier:CLIA.system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
Organization.Slices for identifier.identifier:CLIA.value 0..1 string The value that is unique
Organization.Slices for identifier.identifier:CLIA.period 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:CLIA.assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NAIC This element is included in summaries. C 0..* Identifier NAIC Code
Constraints: us-core-19

Required Pattern: At least the following
Organization.Slices for identifier.identifier:NAIC.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:NAIC.extension 0..* Extension Additional content defined by implementations
Organization.Slices for identifier.identifier:NAIC.use 0..1 code usual | official | temp | secondary | old (If known)
Organization.Slices for identifier.identifier:NAIC.type 0..1 CodeableConcept Description of identifier
Organization.Slices for identifier.identifier:NAIC.system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.6.300
Organization.Slices for identifier.identifier:NAIC.value 0..1 string The value that is unique
Organization.Slices for identifier.identifier:NAIC.period 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:NAIC.assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
Organization.type This element is included in summaries. 0..* CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.
Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
Organization.alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
Organization.telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
Organization.telecom.id 0..1 string Unique id for inter-element referencing
Organization.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Organization.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.address This element must be supported. C 0..* Address An address for the organization
Constraints: org-2
Organization.address.id 0..1 string Unique id for inter-element referencing
Organization.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Organization.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.address.line This element must be supported. This element is included in summaries. 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
Organization.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Organization.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Organization.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Organization.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Organization.partOf This element is included in summaries. 0..1 Reference(Organization) The organization of which this organization forms a part
Organization.contact 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.id 0..1 string Unique id for inter-element referencing
Organization.contact.extension 0..* Extension Additional content defined by implementations
Organization.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
Organization.contact.name 0..1 HumanName A name associated with the contact
Organization.contact.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.address 0..1 Address Visiting or postal addresses for the contact
Organization.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Organization.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Organization.type Base example Organization type 📦4.0.1 FHIR Std.
Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
Organization.address.​type Base required AddressType 📍4.0.1 FHIR Std.
Organization.address.​state Base extensible USPS Two Letter Alphabetic Codes 📦6.1.0 US Core v6.1
Organization.contact.​purpose Base extensible Contact entity type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
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()
us-core-16 error Organization.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
us-core-17 error Organization.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
us-core-18 error Organization.identifier:CLIA CLIA number must be 10 digits with a letter "D" in third position value.matches('^[0-9]{2}D[0-9]{7}$')
us-core-19 error Organization.identifier:NAIC NAIC must be 5 digits value.matches('^[0-9]{5}$')

This structure is derived from USCoreOrganizationProfile

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* USCoreOrganizationProfile(6.1.0) A grouping of people or organizations with a common purpose
Constraints: org-1
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element must be supported. This element is included in summaries. C 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Organization.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..* Identifier National Provider Identifier (NPI)
Constraints: us-core-16, us-core-17

Required Pattern: At least the following
Organization.Slices for identifier.identifier:NPI.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:NPI.extension 0..* Extension Additional content defined by implementations
Organization.Slices for identifier.identifier:NPI.use 0..1 code usual | official | temp | secondary | old (If known)
Organization.Slices for identifier.identifier:NPI.type 0..1 CodeableConcept Description of identifier
Organization.Slices for identifier.identifier:NPI.system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
Organization.Slices for identifier.identifier:NPI.value 0..1 string The value that is unique
Organization.Slices for identifier.identifier:NPI.period 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:NPI.assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:CLIA This element is included in summaries. C 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Constraints: us-core-18

Required Pattern: At least the following
Organization.Slices for identifier.identifier:CLIA.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:CLIA.extension 0..* Extension Additional content defined by implementations
Organization.Slices for identifier.identifier:CLIA.use 0..1 code usual | official | temp | secondary | old (If known)
Organization.Slices for identifier.identifier:CLIA.type 0..1 CodeableConcept Description of identifier
Organization.Slices for identifier.identifier:CLIA.system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
Organization.Slices for identifier.identifier:CLIA.value 0..1 string The value that is unique
Organization.Slices for identifier.identifier:CLIA.period 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:CLIA.assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NAIC This element is included in summaries. C 0..* Identifier NAIC Code
Constraints: us-core-19

Required Pattern: At least the following
Organization.Slices for identifier.identifier:NAIC.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:NAIC.extension 0..* Extension Additional content defined by implementations
Organization.Slices for identifier.identifier:NAIC.use 0..1 code usual | official | temp | secondary | old (If known)
Organization.Slices for identifier.identifier:NAIC.type 0..1 CodeableConcept Description of identifier
Organization.Slices for identifier.identifier:NAIC.system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.6.300
Organization.Slices for identifier.identifier:NAIC.value 0..1 string The value that is unique
Organization.Slices for identifier.identifier:NAIC.period 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:NAIC.assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
Organization.telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
Organization.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Organization.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.address This element must be supported. C 0..* Address An address for the organization
Constraints: org-2
Organization.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.address.line This element must be supported. This element is included in summaries. 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
Organization.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Organization.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Organization.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
Organization.address.​state Base extensible USPS Two Letter Alphabetic Codes 📦6.1.0 US Core v6.1

Constraints

Id Grade Path(s) Description Expression
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()
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()
us-core-16 error Organization.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
us-core-17 error Organization.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
us-core-18 error Organization.identifier:CLIA CLIA number must be 10 digits with a letter "D" in third position value.matches('^[0-9]{2}D[0-9]{7}$')
us-core-19 error Organization.identifier:NAIC NAIC must be 5 digits value.matches('^[0-9]{5}$')

Differential View

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization 0..* USCoreOrganizationProfile(6.1.0) A grouping of people or organizations with a common purpose

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Organization C 0..* USCoreOrganizationProfile(6.1.0) A grouping of people or organizations with a common purpose
Constraints: org-1
Organization.id This element is included in summaries. 0..1 id Logical id of this artifact
Organization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Organization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Organization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Organization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Organization.contained 0..* Resource Contained, inline Resources
Organization.extension 0..* Extension Additional content defined by implementations
Organization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Organization.Slices for identifier This element must be supported. This element is included in summaries. C 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Organization.Slices for identifier.identifier:All Slices Content/Rules for all slices
Organization.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Organization.Slices for identifier.identifier:All Slices.type This element is included in summaries. 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.
Organization.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Organization.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 0..1 string The value that is unique
Example General: 123456
Organization.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..* Identifier National Provider Identifier (NPI)
Constraints: us-core-16, us-core-17

Required Pattern: At least the following
Organization.Slices for identifier.identifier:NPI.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:NPI.extension 0..* Extension Additional content defined by implementations
Organization.Slices for identifier.identifier:NPI.use 0..1 code usual | official | temp | secondary | old (If known)
Organization.Slices for identifier.identifier:NPI.type 0..1 CodeableConcept Description of identifier
Organization.Slices for identifier.identifier:NPI.system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
Organization.Slices for identifier.identifier:NPI.value 0..1 string The value that is unique
Organization.Slices for identifier.identifier:NPI.period 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:NPI.assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:CLIA This element is included in summaries. C 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Constraints: us-core-18

Required Pattern: At least the following
Organization.Slices for identifier.identifier:CLIA.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:CLIA.extension 0..* Extension Additional content defined by implementations
Organization.Slices for identifier.identifier:CLIA.use 0..1 code usual | official | temp | secondary | old (If known)
Organization.Slices for identifier.identifier:CLIA.type 0..1 CodeableConcept Description of identifier
Organization.Slices for identifier.identifier:CLIA.system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
Organization.Slices for identifier.identifier:CLIA.value 0..1 string The value that is unique
Organization.Slices for identifier.identifier:CLIA.period 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:CLIA.assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.Slices for identifier.identifier:NAIC This element is included in summaries. C 0..* Identifier NAIC Code
Constraints: us-core-19

Required Pattern: At least the following
Organization.Slices for identifier.identifier:NAIC.id 0..1 string Unique id for inter-element referencing
Organization.Slices for identifier.identifier:NAIC.extension 0..* Extension Additional content defined by implementations
Organization.Slices for identifier.identifier:NAIC.use 0..1 code usual | official | temp | secondary | old (If known)
Organization.Slices for identifier.identifier:NAIC.type 0..1 CodeableConcept Description of identifier
Organization.Slices for identifier.identifier:NAIC.system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.6.300
Organization.Slices for identifier.identifier:NAIC.value 0..1 string The value that is unique
Organization.Slices for identifier.identifier:NAIC.period 0..1 Period Time period when id is/was valid for use
Organization.Slices for identifier.identifier:NAIC.assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
Organization.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether the organization's record is still in active use
Organization.type This element is included in summaries. 0..* CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.
Organization.name This element must be supported. This element is included in summaries. C 1..1 string Name used for the organization
Organization.alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
Organization.telecom This element must be supported. C 0..* ContactPoint A contact detail for the organization
Constraints: org-3
Organization.telecom.id 0..1 string Unique id for inter-element referencing
Organization.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Organization.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Organization.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Organization.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Organization.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Organization.address This element must be supported. C 0..* Address An address for the organization
Constraints: org-2
Organization.address.id 0..1 string Unique id for inter-element referencing
Organization.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Organization.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Organization.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Organization.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Organization.address.line This element must be supported. This element is included in summaries. 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
Organization.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Organization.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Organization.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Organization.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Organization.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Organization.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Organization.partOf This element is included in summaries. 0..1 Reference(Organization) The organization of which this organization forms a part
Organization.contact 0..* BackboneElement Contact for the organization for a certain purpose
Organization.contact.id 0..1 string Unique id for inter-element referencing
Organization.contact.extension 0..* Extension Additional content defined by implementations
Organization.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Organization.contact.purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
Organization.contact.name 0..1 HumanName A name associated with the contact
Organization.contact.telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
Organization.contact.address 0..1 Address Visiting or postal addresses for the contact
Organization.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Organization.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Organization.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Organization.type Base example Organization type 📦4.0.1 FHIR Std.
Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
Organization.address.​type Base required AddressType 📍4.0.1 FHIR Std.
Organization.address.​state Base extensible USPS Two Letter Alphabetic Codes 📦6.1.0 US Core v6.1
Organization.contact.​purpose Base extensible Contact entity type 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
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()
us-core-16 error Organization.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
us-core-17 error Organization.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
us-core-18 error Organization.identifier:CLIA CLIA number must be 10 digits with a letter "D" in third position value.matches('^[0-9]{2}D[0-9]{7}$')
us-core-19 error Organization.identifier:NAIC NAIC must be 5 digits value.matches('^[0-9]{5}$')

This structure is derived from USCoreOrganizationProfile

Summary

 

Other representations of profile: CSV, Excel, Schematron