National Healthcare Directory Query, published by HL7 International - Patient Administration Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-query/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: National Directory Endpoint Qry Exchange OrganizationAffiliation

The OrganizationAffiliation resource describes relationships between two or more organizations, including the services one organization provides another, the location(s) where they provide services, the availability of those services, electronic endpoints, and other relevant information.

Usage:

• Refer to this Resource Profile:
• Examples for this Resource Profile: OrganizationAffiliation/BurrClinicAffil, OrganizationAffiliation/ConnHIEAffil, OrganizationAffiliation/HamiltonClinicAffil, OrganizationAffiliation/HartfordOrthopedicAffil, OrganizationAffiliation/PharmChainAffil1, OrganizationAffiliation/PharmChainAffil2, OrganizationAffiliation/PharmChainAffil3

Formal Views of Profile Content

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

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

This structure is derived from OrganizationAffiliation

Name	Flags	Card.	Type	Description & Constraints
OrganizationAffiliation	C	0..*	OrganizationAffiliation	Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship organization-or-participatingOrganization: NatlDirEndpointQryOrganizationAffiliation.organization or NatlDirEndpointQryOrganizationAffiliation.participatingOrganization
meta
lastUpdated		1..1	instant	When the resource version last changed
identifier	S	0..*	Identifier	Business identifiers that are specific to this role
assigner	S	0..1	Reference(Organization)	Organization that issued id (may be just text)
active		1..1	boolean	Whether this organization affiliation record is in active use Required Pattern: true
organization	S	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization where the role is available
participatingOrganization	S	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization that provides/performs the role (e.g. providing services or is a member of)
network		0..*	Reference(National Directory Endpoint Qry Exchange Network)	Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
code		0..*	CodeableConcept	Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible)
specialty		0..*	CodeableConcept	Specific specialty of the participatingOrganization in the context of the role Binding: Specialties Value Set (required)
location	S	0..*	Reference(National Directory Endpoint Qry Exchange Location)	The location(s) at which the role occurs
healthcareService		0..*	Reference(National Directory Endpoint Qry Exchange HealthcareService)	Healthcare services provided through the role
endpoint	S	0..*	Reference(National Directory Endpoint Qry Exchange Endpoint)	Technical endpoints providing access to services operated for this role
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
OrganizationAffiliation.code	extensible	OrganizationAffiliationRoleVS
OrganizationAffiliation.specialty	required	SpecialtiesVS

Constraints

Id	Grade	Path(s)	Details	Requirements
organization-or-participatingOrganization	error	OrganizationAffiliation	NatlDirEndpointQryOrganizationAffiliation.organization or NatlDirEndpointQryOrganizationAffiliation.participatingOrganization : organization.exists() or participatingOrganization.exists()

Name	Flags	Card.	Type	Description & Constraints
OrganizationAffiliation	C	0..*	OrganizationAffiliation	Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship organization-or-participatingOrganization: NatlDirEndpointQryOrganizationAffiliation.organization or NatlDirEndpointQryOrganizationAffiliation.participatingOrganization
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business identifiers that are specific to this role
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
assigner	SΣ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	Σ	1..1	boolean	Whether this organization affiliation record is in active use Required Pattern: true
organization	SΣ	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization where the role is available
participatingOrganization	SΣ	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization that provides/performs the role (e.g. providing services or is a member of)
network	Σ	0..*	Reference(National Directory Endpoint Qry Exchange Network)	Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
code	Σ	0..*	CodeableConcept	Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible)
specialty	Σ	0..*	CodeableConcept	Specific specialty of the participatingOrganization in the context of the role Binding: Specialties Value Set (required)
location	SΣ	0..*	Reference(National Directory Endpoint Qry Exchange Location)	The location(s) at which the role occurs
healthcareService		0..*	Reference(National Directory Endpoint Qry Exchange HealthcareService)	Healthcare services provided through the role
endpoint	S	0..*	Reference(National Directory Endpoint Qry Exchange Endpoint)	Technical endpoints providing access to services operated for this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
OrganizationAffiliation.identifier.use	required	IdentifierUse
OrganizationAffiliation.code	extensible	OrganizationAffiliationRoleVS
OrganizationAffiliation.specialty	required	SpecialtiesVS

Constraints

Id	Grade	Path(s)	Details	Requirements
organization-or-participatingOrganization	error	OrganizationAffiliation	NatlDirEndpointQryOrganizationAffiliation.organization or NatlDirEndpointQryOrganizationAffiliation.participatingOrganization : organization.exists() or participatingOrganization.exists()

Name	Flags	Card.	Type	Description & Constraints
OrganizationAffiliation	C	0..*	OrganizationAffiliation	Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship organization-or-participatingOrganization: NatlDirEndpointQryOrganizationAffiliation.organization or NatlDirEndpointQryOrganizationAffiliation.participatingOrganization
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
identifier	SΣ	0..*	Identifier	Business identifiers that are specific to this role
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	Σ	1..1	boolean	Whether this organization affiliation record is in active use Required Pattern: true
period	Σ	0..1	Period	The period during which the participatingOrganization is affiliated with the primary organization
organization	SΣ	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization where the role is available
participatingOrganization	SΣ	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization that provides/performs the role (e.g. providing services or is a member of)
network	Σ	0..*	Reference(National Directory Endpoint Qry Exchange Network)	Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
code	Σ	0..*	CodeableConcept	Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible)
specialty	Σ	0..*	CodeableConcept	Specific specialty of the participatingOrganization in the context of the role Binding: Specialties Value Set (required)
location	SΣ	0..*	Reference(National Directory Endpoint Qry Exchange Location)	The location(s) at which the role occurs
healthcareService		0..*	Reference(National Directory Endpoint Qry Exchange HealthcareService)	Healthcare services provided through the role
telecom	Σ	0..*	ContactPoint	Contact details at the participatingOrganization relevant to this Affiliation
endpoint	S	0..*	Reference(National Directory Endpoint Qry Exchange Endpoint)	Technical endpoints providing access to services operated for this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
OrganizationAffiliation.meta.security	extensible	All Security Labels
OrganizationAffiliation.meta.tag	example	CommonTags
OrganizationAffiliation.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
OrganizationAffiliation.identifier.use	required	IdentifierUse
OrganizationAffiliation.identifier.type	extensible	Identifier Type Codes
OrganizationAffiliation.code	extensible	OrganizationAffiliationRoleVS
OrganizationAffiliation.specialty	required	SpecialtiesVS

This structure is derived from OrganizationAffiliation

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 6 elements

Structures

This structure refers to these other structures:

• National Directory Endpoint Qry Exchange Organization (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Organization)
• National Directory Endpoint Qry Exchange Network (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Network)
• National Directory Endpoint Qry Exchange Location (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Location)
• National Directory Endpoint Qry Exchange HealthcareService (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-HealthcareService)
• National Directory Endpoint Qry Exchange Endpoint (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Endpoint)

Differential View

This structure is derived from OrganizationAffiliation

Name	Flags	Card.	Type	Description & Constraints
OrganizationAffiliation	C	0..*	OrganizationAffiliation	Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship organization-or-participatingOrganization: NatlDirEndpointQryOrganizationAffiliation.organization or NatlDirEndpointQryOrganizationAffiliation.participatingOrganization
meta
lastUpdated		1..1	instant	When the resource version last changed
identifier	S	0..*	Identifier	Business identifiers that are specific to this role
assigner	S	0..1	Reference(Organization)	Organization that issued id (may be just text)
active		1..1	boolean	Whether this organization affiliation record is in active use Required Pattern: true
organization	S	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization where the role is available
participatingOrganization	S	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization that provides/performs the role (e.g. providing services or is a member of)
network		0..*	Reference(National Directory Endpoint Qry Exchange Network)	Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
code		0..*	CodeableConcept	Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible)
specialty		0..*	CodeableConcept	Specific specialty of the participatingOrganization in the context of the role Binding: Specialties Value Set (required)
location	S	0..*	Reference(National Directory Endpoint Qry Exchange Location)	The location(s) at which the role occurs
healthcareService		0..*	Reference(National Directory Endpoint Qry Exchange HealthcareService)	Healthcare services provided through the role
endpoint	S	0..*	Reference(National Directory Endpoint Qry Exchange Endpoint)	Technical endpoints providing access to services operated for this role
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
OrganizationAffiliation.code	extensible	OrganizationAffiliationRoleVS
OrganizationAffiliation.specialty	required	SpecialtiesVS

Constraints

Id	Grade	Path(s)	Details	Requirements
organization-or-participatingOrganization	error	OrganizationAffiliation	NatlDirEndpointQryOrganizationAffiliation.organization or NatlDirEndpointQryOrganizationAffiliation.participatingOrganization : organization.exists() or participatingOrganization.exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
OrganizationAffiliation	C	0..*	OrganizationAffiliation	Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship organization-or-participatingOrganization: NatlDirEndpointQryOrganizationAffiliation.organization or NatlDirEndpointQryOrganizationAffiliation.participatingOrganization
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business identifiers that are specific to this role
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
assigner	SΣ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	Σ	1..1	boolean	Whether this organization affiliation record is in active use Required Pattern: true
organization	SΣ	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization where the role is available
participatingOrganization	SΣ	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization that provides/performs the role (e.g. providing services or is a member of)
network	Σ	0..*	Reference(National Directory Endpoint Qry Exchange Network)	Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
code	Σ	0..*	CodeableConcept	Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible)
specialty	Σ	0..*	CodeableConcept	Specific specialty of the participatingOrganization in the context of the role Binding: Specialties Value Set (required)
location	SΣ	0..*	Reference(National Directory Endpoint Qry Exchange Location)	The location(s) at which the role occurs
healthcareService		0..*	Reference(National Directory Endpoint Qry Exchange HealthcareService)	Healthcare services provided through the role
endpoint	S	0..*	Reference(National Directory Endpoint Qry Exchange Endpoint)	Technical endpoints providing access to services operated for this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
OrganizationAffiliation.identifier.use	required	IdentifierUse
OrganizationAffiliation.code	extensible	OrganizationAffiliationRoleVS
OrganizationAffiliation.specialty	required	SpecialtiesVS

Constraints

Id	Grade	Path(s)	Details	Requirements
organization-or-participatingOrganization	error	OrganizationAffiliation	NatlDirEndpointQryOrganizationAffiliation.organization or NatlDirEndpointQryOrganizationAffiliation.participatingOrganization : organization.exists() or participatingOrganization.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
OrganizationAffiliation	C	0..*	OrganizationAffiliation	Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship organization-or-participatingOrganization: NatlDirEndpointQryOrganizationAffiliation.organization or NatlDirEndpointQryOrganizationAffiliation.participatingOrganization
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
identifier	SΣ	0..*	Identifier	Business identifiers that are specific to this role
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	Σ	1..1	boolean	Whether this organization affiliation record is in active use Required Pattern: true
period	Σ	0..1	Period	The period during which the participatingOrganization is affiliated with the primary organization
organization	SΣ	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization where the role is available
participatingOrganization	SΣ	0..1	Reference(National Directory Endpoint Qry Exchange Organization)	Organization that provides/performs the role (e.g. providing services or is a member of)
network	Σ	0..*	Reference(National Directory Endpoint Qry Exchange Network)	Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
code	Σ	0..*	CodeableConcept	Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible)
specialty	Σ	0..*	CodeableConcept	Specific specialty of the participatingOrganization in the context of the role Binding: Specialties Value Set (required)
location	SΣ	0..*	Reference(National Directory Endpoint Qry Exchange Location)	The location(s) at which the role occurs
healthcareService		0..*	Reference(National Directory Endpoint Qry Exchange HealthcareService)	Healthcare services provided through the role
telecom	Σ	0..*	ContactPoint	Contact details at the participatingOrganization relevant to this Affiliation
endpoint	S	0..*	Reference(National Directory Endpoint Qry Exchange Endpoint)	Technical endpoints providing access to services operated for this role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
OrganizationAffiliation.meta.security	extensible	All Security Labels
OrganizationAffiliation.meta.tag	example	CommonTags
OrganizationAffiliation.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
OrganizationAffiliation.identifier.use	required	IdentifierUse
OrganizationAffiliation.identifier.type	extensible	Identifier Type Codes
OrganizationAffiliation.code	extensible	OrganizationAffiliationRoleVS
OrganizationAffiliation.specialty	required	SpecialtiesVS

This structure is derived from OrganizationAffiliation

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 6 elements

Structures

This structure refers to these other structures:

• National Directory Endpoint Qry Exchange Organization (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Organization)
• National Directory Endpoint Qry Exchange Network (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Network)
• National Directory Endpoint Qry Exchange Location (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Location)
• National Directory Endpoint Qry Exchange HealthcareService (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-HealthcareService)
• National Directory Endpoint Qry Exchange Endpoint (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Endpoint)

Other representations of profile: CSV, Excel, Schematron