US Core Maturity: 5

Example Usage Scenarios:

The following are example usage scenarios for this profile:

• Query by organization name or NPI

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Organization Must Have:

1. A status of the organization (i.e., whether it is still active )
2. A name

Each Organization Must Support:

1. An identifier¹
2. A list of contact information
3. An address²

^1,2 see guidance below

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

• ¹Systems SHALL support National Provider Identifier (NPI) for organizations^§ and SHOULD support Clinical Laboratory Improvement Amendments (CLIA) for laboratories and the National Association of Insurance Commissioners NAIC Company code (sometimes called "NAIC Number" or "cocode") for payers.^§,§
• ² For Organization.address.state, this profile uses USPS Two Letter Alphabetic Codes for US states. When encoding addresses outside the US, systems SHOULD use the ISO 3166 subdivision codes.^§

Changes since version 9.0.0:

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	Organization	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	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:$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	S 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	S 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	S 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: { "system" : "http://hl7.org/fhir/sid/us-npi" }
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: { "system" : "urn:oid:2.16.840.1.113883.4.7" }
Organization.Slices for identifier.identifier:NAIC	Σ This element is included in summaries. C	0..*	Identifier	NAIC Code Constraints: us-core-19 Required Pattern: { "system" : "urn:oid:2.16.840.1.113883.6.300" }
Organization.active	?! This element is a modifier element. S 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	S This element must be supported. Σ This element is included in summaries. C	1..1	string	Name used for the organization
Organization.telecom	S This element must be supported. C	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
Organization.telecom.system	S 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	S 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	S 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	S 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 Example US Core: 49 MEADOW ST
Organization.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
Organization.address.state	S 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. Example US Core: OK
Organization.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047
Organization.address.country	S 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)
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	📦2.0.0	THO v7.4

Constraints

Id	Grade	Path(s)	Description	Expression
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 Organization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization		0..*	Organization	A grouping of people or organizations with a common purpose
Organization.Slices for identifier	S This element must be supported.	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:$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.system	S This element must be supported.	0..1	uri	The namespace for the identifier value
Organization.Slices for identifier.identifier:All Slices.value	S This element must be supported.	0..1	string	The value that is unique
Organization.Slices for identifier.identifier:NPI	S This element must be supported. C	0..*	Identifier	National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 Required Pattern: { "system" : "http://hl7.org/fhir/sid/us-npi" }
Organization.Slices for identifier.identifier:CLIA	C	0..*	Identifier	Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Constraints: us-core-18 Required Pattern: { "system" : "urn:oid:2.16.840.1.113883.4.7" }
Organization.Slices for identifier.identifier:NAIC	C	0..*	Identifier	NAIC Code Constraints: us-core-19 Required Pattern: { "system" : "urn:oid:2.16.840.1.113883.6.300" }
Organization.active	S This element must be supported.	1..1	boolean	Whether the organization's record is still in active use
Organization.name	S This element must be supported.	1..1	string	Name used for the organization
Organization.telecom	S This element must be supported.	0..*	ContactPoint	A contact detail for the organization
Organization.telecom.system	S This element must be supported.	0..1	code	phone | fax | email | pager | url | sms | other
Organization.telecom.value	S This element must be supported.	0..1	string	The actual contact point details
Organization.address	S This element must be supported.	0..*	Address	An address for the organization
Organization.address.line	S This element must be supported.	0..4	string	Street name, number, direction & P.O. Box etc. Example US Core: 49 MEADOW ST
Organization.address.city	S This element must be supported.	0..1	string	Name of city, town etc. Example US Core: EVERYTOWN
Organization.address.state	S This element must be supported.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK
Organization.address.postalCode	S This element must be supported.	0..1	string	US Zip Codes Example US Core: 74047
Organization.address.country	S This element must be supported.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.address.​state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4

Constraints

Id	Grade	Path(s)	Description	Expression
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}$')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	Organization	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 Bindings Purpose 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	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:$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	S 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	S 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	S 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: { "system" : "http://hl7.org/fhir/sid/us-npi" }
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: { "system" : "urn:oid:2.16.840.1.113883.4.7" }
Organization.Slices for identifier.identifier:NAIC	Σ This element is included in summaries. C	0..*	Identifier	NAIC Code Constraints: us-core-19 Required Pattern: { "system" : "urn:oid:2.16.840.1.113883.6.300" }
Organization.active	?! This element is a modifier element. S 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	S 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	S 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	S 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	S 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	S 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	S 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 Example US Core: 49 MEADOW ST
Organization.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
Organization.address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Organization.address.state	S 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. Example US Core: OK
Organization.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047
Organization.address.country	S 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
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	📦2.0.0	THO v7.4
Organization.contact.​purpose	Base	extensible	Contact entity type	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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}$')

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	Organization	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	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:$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	S 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	S 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	S 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: { "system" : "http://hl7.org/fhir/sid/us-npi" }
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: { "system" : "urn:oid:2.16.840.1.113883.4.7" }
Organization.Slices for identifier.identifier:NAIC	Σ This element is included in summaries. C	0..*	Identifier	NAIC Code Constraints: us-core-19 Required Pattern: { "system" : "urn:oid:2.16.840.1.113883.6.300" }
Organization.active	?! This element is a modifier element. S 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	S This element must be supported. Σ This element is included in summaries. C	1..1	string	Name used for the organization
Organization.telecom	S This element must be supported. C	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
Organization.telecom.system	S 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	S 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	S 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	S 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 Example US Core: 49 MEADOW ST
Organization.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
Organization.address.state	S 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. Example US Core: OK
Organization.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047
Organization.address.country	S 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)
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	📦2.0.0	THO v7.4

Constraints

Id	Grade	Path(s)	Description	Expression
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 Organization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization		0..*	Organization	A grouping of people or organizations with a common purpose
Organization.Slices for identifier	S This element must be supported.	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:$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.system	S This element must be supported.	0..1	uri	The namespace for the identifier value
Organization.Slices for identifier.identifier:All Slices.value	S This element must be supported.	0..1	string	The value that is unique
Organization.Slices for identifier.identifier:NPI	S This element must be supported. C	0..*	Identifier	National Provider Identifier (NPI) Constraints: us-core-16, us-core-17 Required Pattern: { "system" : "http://hl7.org/fhir/sid/us-npi" }
Organization.Slices for identifier.identifier:CLIA	C	0..*	Identifier	Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Constraints: us-core-18 Required Pattern: { "system" : "urn:oid:2.16.840.1.113883.4.7" }
Organization.Slices for identifier.identifier:NAIC	C	0..*	Identifier	NAIC Code Constraints: us-core-19 Required Pattern: { "system" : "urn:oid:2.16.840.1.113883.6.300" }
Organization.active	S This element must be supported.	1..1	boolean	Whether the organization's record is still in active use
Organization.name	S This element must be supported.	1..1	string	Name used for the organization
Organization.telecom	S This element must be supported.	0..*	ContactPoint	A contact detail for the organization
Organization.telecom.system	S This element must be supported.	0..1	code	phone | fax | email | pager | url | sms | other
Organization.telecom.value	S This element must be supported.	0..1	string	The actual contact point details
Organization.address	S This element must be supported.	0..*	Address	An address for the organization
Organization.address.line	S This element must be supported.	0..4	string	Street name, number, direction & P.O. Box etc. Example US Core: 49 MEADOW ST
Organization.address.city	S This element must be supported.	0..1	string	Name of city, town etc. Example US Core: EVERYTOWN
Organization.address.state	S This element must be supported.	0..1	string	Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK
Organization.address.postalCode	S This element must be supported.	0..1	string	US Zip Codes Example US Core: 74047
Organization.address.country	S This element must be supported.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.address.​state	Base	extensible	USPS Two Letter Alphabetic Codes	📦2.0.0	THO v7.4

Constraints

Id	Grade	Path(s)	Description	Expression
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}$')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Organization	C	0..*	Organization	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 Bindings Purpose 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	S This element must be supported. Σ This element is included in summaries. C	0..*	Identifier	Identifies this organization across multiple systems Slice: Unordered, Open by value:$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	S 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	S 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	S 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: { "system" : "http://hl7.org/fhir/sid/us-npi" }
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: { "system" : "urn:oid:2.16.840.1.113883.4.7" }
Organization.Slices for identifier.identifier:NAIC	Σ This element is included in summaries. C	0..*	Identifier	NAIC Code Constraints: us-core-19 Required Pattern: { "system" : "urn:oid:2.16.840.1.113883.6.300" }
Organization.active	?! This element is a modifier element. S 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	S 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	S 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	S 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	S 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	S 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	S 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 Example US Core: 49 MEADOW ST
Organization.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
Organization.address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Organization.address.state	S 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. Example US Core: OK
Organization.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132 Example US Core: 74047
Organization.address.country	S 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
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	📦2.0.0	THO v7.4
Organization.contact.​purpose	Base	extensible	Contact entity type	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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 Organization

Summary

Mandatory: 2 elements
Must-Support: 15 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Organization.identifier

Maturity: 5

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

• See the Scopes Format section for a description of the SMART scopes syntax.
• See the Search Syntax section for a description of the US Core search syntax.
• See the General Requirements section for additional rules and expectations when a Server requires status parameters.
• See the General Guidance section for additional guidance on searching for multiple patients.

US Core Scopes

Servers providing access to organization data SHALL support these US Core SMART Scopes:

• resource level scopes: <patient|user|system>/Organization.rs ^§

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

1. SHALL support searching organization based on text address using the address search parameter

   GET [base]/Organization?address=[address]

   Example:

   1. GET [base]/Organization?address=Ann%20Arbor

   Implementation Notes: Fetches a bundle of all US Core Organization Profile resources that match the address string ( see how to search by string).

2. SHALL support searching by organization name using the name search parameter

   GET [base]/Organization?name=[name]

   Example:

   1. GET [base]/Organization?name=ACME%20Labs

   Implementation Notes: Fetches a bundle of all US Core Organization Profile resources that match the name ( see how to search by string).