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*

*see guidance below

Profile Specific Implementation Guidance:

• *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.
• * Systems SHOULD follow the Project IE@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for Organization.address.line and  Organization.address.city.

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

This structure is derived from Organization

Name	Flags	Card.	Type	Description & Constraints
Organization		0..*	Organization	A grouping of people or organizations with a common purpose
Slices for identifier	S	0..*	IECoreCompanyRegistrationNumber	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system
identifier:CRN	S	0..1	Identifier	Company Registration Number (CRN)
active	S	1..1	boolean	Whether the organization's record is still in active use
name	S	1..1	string	Name used for the organization
telecom	S	0..*	ContactPoint	A contact detail for the organization
system	S	0..1	code	phone | fax | email | pager | url | sms | other
value	S	0..1	string	The actual contact point details
address	S	0..*	Address	An address for the organization
line	S	0..*	string	Street name, number, direction & P.O. Box etc. Example General: 51 Bracken Rd
city	S	0..1	string	Name of city, town etc. Example General: Sandyford
state	S	0..1	string	Sub-unit of country (abbreviations ok) Binding: Ireland Counties (extensible): County Example General: Dublin
postalCode	S	0..1	string	IE Eircodes Example General: D18 CV48
country	S	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Organization.address.state	extensible	IECoreCounties (a valid code from Irish Counties) http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties from this IG

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	Organization	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	0..*	IECoreCompanyRegistrationNumber	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system
identifier:CRN	SΣC	0..1	Identifier	Company Registration Number (CRN)
active	?!SΣ	1..1	boolean	Whether the organization's record is still in active use
name	SΣC	1..1	string	Name used for the organization
telecom	SC	0..*	ContactPoint	A contact detail for the organization org-3: The telecom of an organization can never be of use 'home'
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address	SC	0..*	Address	An address for the organization org-2: An address of an organization can never be of use 'home'
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line	SΣ	0..*	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 General: 51 Bracken Rd
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon Example General: Sandyford
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Ireland Counties (extensible): County Example General: Dublin
postalCode	SΣ	0..1	string	IE Eircodes Example General: 9132 Example General: D18 CV48
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Organization.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Organization.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Organization.address.state	extensible	IECoreCounties (a valid code from Irish Counties) http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties from this IG

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	Organization	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	0..*	IECoreCompanyRegistrationNumber	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system
identifier:CRN	SΣC	0..1	Identifier	Company Registration Number (CRN)
active	?!SΣ	1..1	boolean	Whether the organization's record is still in active use
type	Σ	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
name	SΣC	1..1	string	Name used for the organization
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SC	0..*	ContactPoint	A contact detail for the organization org-3: The telecom of an organization can never be of use 'home'
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
address	SC	0..*	Address	An address for the organization org-2: An address of an organization can never be of use 'home'
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	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 General: 51 Bracken Rd
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon Example General: Sandyford
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Ireland Counties (extensible): County Example General: Dublin
postalCode	SΣ	0..1	string	IE Eircodes Example General: 9132 Example General: D18 CV48
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact		0..*	BackboneElement	Contact for the organization for a certain purpose
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Organization.type	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type from the FHIR Standard
Organization.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Organization.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Organization.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Organization.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Organization.address.state	extensible	IECoreCounties (a valid code from Irish Counties) http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties from this IG
Organization.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard

Differential View

This structure is derived from Organization

Name	Flags	Card.	Type	Description & Constraints
Organization		0..*	Organization	A grouping of people or organizations with a common purpose
Slices for identifier	S	0..*	IECoreCompanyRegistrationNumber	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system
identifier:CRN	S	0..1	Identifier	Company Registration Number (CRN)
active	S	1..1	boolean	Whether the organization's record is still in active use
name	S	1..1	string	Name used for the organization
telecom	S	0..*	ContactPoint	A contact detail for the organization
system	S	0..1	code	phone | fax | email | pager | url | sms | other
value	S	0..1	string	The actual contact point details
address	S	0..*	Address	An address for the organization
line	S	0..*	string	Street name, number, direction & P.O. Box etc. Example General: 51 Bracken Rd
city	S	0..1	string	Name of city, town etc. Example General: Sandyford
state	S	0..1	string	Sub-unit of country (abbreviations ok) Binding: Ireland Counties (extensible): County Example General: Dublin
postalCode	S	0..1	string	IE Eircodes Example General: D18 CV48
country	S	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Organization.address.state	extensible	IECoreCounties (a valid code from Irish Counties) http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	Organization	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	0..*	IECoreCompanyRegistrationNumber	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system
identifier:CRN	SΣC	0..1	Identifier	Company Registration Number (CRN)
active	?!SΣ	1..1	boolean	Whether the organization's record is still in active use
name	SΣC	1..1	string	Name used for the organization
telecom	SC	0..*	ContactPoint	A contact detail for the organization org-3: The telecom of an organization can never be of use 'home'
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address	SC	0..*	Address	An address for the organization org-2: An address of an organization can never be of use 'home'
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
line	SΣ	0..*	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 General: 51 Bracken Rd
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon Example General: Sandyford
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Ireland Counties (extensible): County Example General: Dublin
postalCode	SΣ	0..1	string	IE Eircodes Example General: 9132 Example General: D18 CV48
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Organization.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Organization.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Organization.address.state	extensible	IECoreCounties (a valid code from Irish Counties) http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Organization	C	0..*	Organization	A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣC	0..*	IECoreCompanyRegistrationNumber	Identifies this organization across multiple systems Slice: Unordered, Open by pattern:system
identifier:CRN	SΣC	0..1	Identifier	Company Registration Number (CRN)
active	?!SΣ	1..1	boolean	Whether the organization's record is still in active use
type	Σ	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
name	SΣC	1..1	string	Name used for the organization
alias		0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	SC	0..*	ContactPoint	A contact detail for the organization org-3: The telecom of an organization can never be of use 'home'
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
address	SC	0..*	Address	An address for the organization org-2: An address of an organization can never be of use 'home'
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	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 General: 51 Bracken Rd
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon Example General: Sandyford
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Ireland Counties (extensible): County Example General: Dublin
postalCode	SΣ	0..1	string	IE Eircodes Example General: 9132 Example General: D18 CV48
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
partOf	Σ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact		0..*	BackboneElement	Contact for the organization for a certain purpose
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
purpose		0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
name		0..1	HumanName	A name associated with the contact
telecom		0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address		0..1	Address	Visiting or postal addresses for the contact
endpoint		0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Organization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Organization.type	example	OrganizationType http://hl7.org/fhir/ValueSet/organization-type from the FHIR Standard
Organization.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Organization.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Organization.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Organization.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Organization.address.state	extensible	IECoreCounties (a valid code from Irish Counties) http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties from this IG
Organization.contact.purpose	extensible	ContactEntityType http://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard

This structure is derived from Organization

Summary

Mandatory: 2 elements
Must-Support: 13 elements

Structures

This structure refers to these other structures:

• IE Core Company Registration Number (http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-company-registration-number)

Slices

This structure defines the following Slices:

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

Maturity: 3

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 IE Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only IE Core Profiles (Profile Only Support) are not required to support these interactions. See the IE 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 IE 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.

IE Core Scopes

Servers providing access to organization data SHALL support these IE 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 by organization name using the name search parameter:

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

   Example:

   1. GET [base]/Organization?name=Health

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

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

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

   Example:

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

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