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

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

Resource Profile: Payor Organization

Example of a payor organization with a required type

Usages:

• Examples for this Profile: Example Health Plan

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• 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.identifier	S This element must be supported. Σ This element is included in summaries. C	1..*	Identifier	Identifies this organization across multiple systems
Organization.identifier.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.identifier.type	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Description of identifier Binding: Payor Identifier Types ValueSet (required)
Organization.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether the organization's record is still in active use
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier.​type	Base	required	Payor Identifier Types ValueSet	📦1.0.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Organization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Organization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Organization	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Organization	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one	(identifier.count() + name.count()) > 0

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.identifier	S This element must be supported.	1..*	Identifier	Identifies this organization across multiple systems
Organization.identifier.type	S This element must be supported.	1..1	CodeableConcept	Description of identifier Binding: Payor Identifier Types ValueSet (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier.​type	Base	required	Payor Identifier Types ValueSet	📦1.0.0	This IG

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.identifier	S This element must be supported. Σ This element is included in summaries. C	1..*	Identifier	Identifies this organization across multiple systems
Organization.identifier.id		0..1	string	Unique id for inter-element referencing
Organization.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.identifier.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.identifier.type	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Description of identifier Binding: Payor Identifier Types ValueSet (required)
Organization.identifier.system	Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Organization.identifier.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether the organization's record is still in active use
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
Organization.name	Σ This element is included in summaries. C	0..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	C	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
Organization.address	C	0..*	Address	An address for the organization Constraints: org-2
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	required	Payor Identifier Types ValueSet	📦1.0.0	This IG
Organization.type	Base	example	Organization type	📍4.0.1	FHIR Std.
Organization.contact.​purpose	Base	extensible	Contact entity type	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Organization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Organization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Organization	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Organization	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one	(identifier.count() + name.count()) > 0
org-2	error	Organization.address	An address of an organization can never be of use 'home'	where(use = 'home').empty()
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home'	where(use = 'home').empty()

This structure is derived from Organization

Summary

Mandatory: 2 elements
Must-Support: 2 elements

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.identifier	S This element must be supported. Σ This element is included in summaries. C	1..*	Identifier	Identifies this organization across multiple systems
Organization.identifier.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.identifier.type	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Description of identifier Binding: Payor Identifier Types ValueSet (required)
Organization.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether the organization's record is still in active use
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Organization.identifier.​type	Base	required	Payor Identifier Types ValueSet	📦1.0.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Organization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Organization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Organization	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Organization	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one	(identifier.count() + name.count()) > 0

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.identifier	S This element must be supported.	1..*	Identifier	Identifies this organization across multiple systems
Organization.identifier.type	S This element must be supported.	1..1	CodeableConcept	Description of identifier Binding: Payor Identifier Types ValueSet (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Organization.identifier.​type	Base	required	Payor Identifier Types ValueSet	📦1.0.0	This IG

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.identifier	S This element must be supported. Σ This element is included in summaries. C	1..*	Identifier	Identifies this organization across multiple systems
Organization.identifier.id		0..1	string	Unique id for inter-element referencing
Organization.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Organization.identifier.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.identifier.type	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Description of identifier Binding: Payor Identifier Types ValueSet (required)
Organization.identifier.system	Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Organization.identifier.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Organization.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Organization.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Organization.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether the organization's record is still in active use
Organization.type	Σ This element is included in summaries.	0..*	CodeableConcept	Kind of organization Binding: OrganizationType (example): Used to categorize the organization.
Organization.name	Σ This element is included in summaries. C	0..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	C	0..*	ContactPoint	A contact detail for the organization Constraints: org-3
Organization.address	C	0..*	Address	An address for the organization Constraints: org-2
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	required	Payor Identifier Types ValueSet	📦1.0.0	This IG
Organization.type	Base	example	Organization type	📍4.0.1	FHIR Std.
Organization.contact.​purpose	Base	extensible	Contact entity type	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Organization	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Organization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Organization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Organization	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Organization	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
org-1	error	Organization	The organization SHALL at least have a name or an identifier, and possibly more than one	(identifier.count() + name.count()) > 0
org-2	error	Organization.address	An address of an organization can never be of use 'home'	where(use = 'home').empty()
org-3	error	Organization.telecom	The telecom of an organization can never be of use 'home'	where(use = 'home').empty()

This structure is derived from Organization

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Other representations of profile: CSV, Excel, Schematron