Implementation Guide
25.0.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena PAS Insurer Organization

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition-athena-pas-insurer-organization-profile.html Version: 25.0.0
Active as of 2026-04-04 Computable Name: PasInsurerOrganization

Organization resource representing the insurer that receives a prior authorization request in PAS workflows.

The PAS Insurer Organization resource is an Organization that provides insurance and is the receiver of a prior authorization request. This profile is required as part of the PAS Claim Bundle and is referenced in the PAS Claim resource.

Goal: Get PAS Insurer Organization resource by ID for inclusion in the Claim Bundle.

Reference: PAS Insurer Organization is referenced in the PAS Claim resource as part of the required Claim Bundle structure.

Required for Claim Bundle. Reference to PAS Insurer Organization in PAS claim resource. PAS Insurer Organization is derived from PAS Base Organization, which in turn is derived from the FHIR R4 Organization resource.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1
... 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..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣC 0..* Identifier National Provider Identifier (NPI)
..... Slices for extension Content/Rules for all slices
...... extension:identifierSubDepartment 0..1 string Identifies a specific subdivision within the organization
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-identifierSubDepartment
...... extension:identifierJurisdiction 0..1 CodeableConcept State/jurisdiction where the NPI is registered
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-identifierJurisdiction
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... identifier:TIN SΣC 0..1 Identifier The US Employer Identification Number (EIN) or Tax Identification Number (TIN).
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://terminology.hl7.org/NamingSystem/USEIN
.... identifier:PI SΣC 0..1 Identifier The Payer Identification Number (PI)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
... type SΣ 0..* CodeableConcept Kind of organization
Binding: https://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98 (required)
... name SΣC 1..1 string Name used for the organization
... telecom SC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ 0..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... address SC 0..* Address An address for the organization
Constraints: org-2
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
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
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.identifier:NPI.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Organization.identifier:TIN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Organization.identifier:PI.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Organization.typerequiredhttps://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98
https://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
From the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
From the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
From the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization 0..* Organization A grouping of people or organizations with a common purpose
... Slices for identifier S 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI S 0..* Identifier National Provider Identifier (NPI)
..... Slices for extension Content/Rules for all slices
...... extension:identifierSubDepartment 0..1 string Identifies a specific subdivision within the organization
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-identifierSubDepartment
...... extension:identifierJurisdiction 0..1 CodeableConcept State/jurisdiction where the NPI is registered
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-identifierJurisdiction
..... type
...... coding 1..* Coding Code defined by a terminology system
....... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 0..1 code Symbol in syntax defined by the system
Required Pattern: NPI
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... identifier:TIN S 0..1 Identifier The US Employer Identification Number (EIN) or Tax Identification Number (TIN).
..... type
...... coding 1..* Coding Code defined by a terminology system
....... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 0..1 code Symbol in syntax defined by the system
Required Pattern: TAX
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://terminology.hl7.org/NamingSystem/USEIN
.... identifier:PI S 0..1 Identifier The Payer Identification Number (PI)
..... type
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: payerid
...... text 0..1 string Plain text representation of the concept
Required Pattern: Complex
... active S 1..1 boolean Whether the organization's record is still in active use
... type S 0..* CodeableConcept Kind of organization
Binding: https://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98 (required)
... telecom S 0..* ContactPoint A contact detail for the organization
.... system S 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value S 0..1 string The actual contact point details
.... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... address S 0..* Address An address for the organization
.... use S 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... state S 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode S 0..1 string Postal code for area
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.typerequiredhttps://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98
https://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
From the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
From the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
From the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1
... 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
... 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
... 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..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣC 0..* Identifier National Provider Identifier (NPI)
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:identifierSubDepartment 0..1 string Identifies a specific subdivision within the organization
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-identifierSubDepartment
...... extension:identifierJurisdiction 0..1 CodeableConcept State/jurisdiction where the NPI is registered
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-identifierJurisdiction
..... 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: NPI
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
..... 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 Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:TIN SΣC 0..1 Identifier The US Employer Identification Number (EIN) or Tax Identification Number (TIN).
..... 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: TAX
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://terminology.hl7.org/NamingSystem/USEIN
..... 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 Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:PI SΣC 0..1 Identifier The Payer Identification Number (PI)
..... 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... 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 Σ 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: payerid
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Complex
..... 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 Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
... type SΣ 0..* CodeableConcept Kind of organization
Binding: https://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98 (required)
... 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
Constraints: org-3
.... 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)
.... value SΣ 0..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... 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
Constraints: org-2
.... 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 ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
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
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:NPI.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Organization.identifier:NPI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Organization.identifier:TIN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Organization.identifier:TIN.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Organization.identifier:PI.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Organization.identifier:PI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Organization.typerequiredhttps://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98
https://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
From the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
From the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
From the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from Organization

Summary

Mandatory: 2 elements(7 nested mandatory elements)
Must-Support: 18 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1
... 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..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣC 0..* Identifier National Provider Identifier (NPI)
..... Slices for extension Content/Rules for all slices
...... extension:identifierSubDepartment 0..1 string Identifies a specific subdivision within the organization
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-identifierSubDepartment
...... extension:identifierJurisdiction 0..1 CodeableConcept State/jurisdiction where the NPI is registered
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-identifierJurisdiction
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... identifier:TIN SΣC 0..1 Identifier The US Employer Identification Number (EIN) or Tax Identification Number (TIN).
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://terminology.hl7.org/NamingSystem/USEIN
.... identifier:PI SΣC 0..1 Identifier The Payer Identification Number (PI)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
... type SΣ 0..* CodeableConcept Kind of organization
Binding: https://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98 (required)
... name SΣC 1..1 string Name used for the organization
... telecom SC 0..* ContactPoint A contact detail for the organization
Constraints: org-3
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ 0..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... address SC 0..* Address An address for the organization
Constraints: org-2
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
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
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.identifier:NPI.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Organization.identifier:TIN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Organization.identifier:PI.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Organization.typerequiredhttps://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98
https://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
From the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
From the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
From the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization 0..* Organization A grouping of people or organizations with a common purpose
... Slices for identifier S 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI S 0..* Identifier National Provider Identifier (NPI)
..... Slices for extension Content/Rules for all slices
...... extension:identifierSubDepartment 0..1 string Identifies a specific subdivision within the organization
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-identifierSubDepartment
...... extension:identifierJurisdiction 0..1 CodeableConcept State/jurisdiction where the NPI is registered
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-identifierJurisdiction
..... type
...... coding 1..* Coding Code defined by a terminology system
....... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 0..1 code Symbol in syntax defined by the system
Required Pattern: NPI
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
.... identifier:TIN S 0..1 Identifier The US Employer Identification Number (EIN) or Tax Identification Number (TIN).
..... type
...... coding 1..* Coding Code defined by a terminology system
....... system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 0..1 code Symbol in syntax defined by the system
Required Pattern: TAX
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://terminology.hl7.org/NamingSystem/USEIN
.... identifier:PI S 0..1 Identifier The Payer Identification Number (PI)
..... type
...... coding 1..* Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: payerid
...... text 0..1 string Plain text representation of the concept
Required Pattern: Complex
... active S 1..1 boolean Whether the organization's record is still in active use
... type S 0..* CodeableConcept Kind of organization
Binding: https://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98 (required)
... telecom S 0..* ContactPoint A contact detail for the organization
.... system S 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value S 0..1 string The actual contact point details
.... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... address S 0..* Address An address for the organization
.... use S 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
.... line S 0..* string Street name, number, direction & P.O. Box etc.
.... city S 0..1 string Name of city, town etc.
.... state S 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode S 0..1 string Postal code for area
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.typerequiredhttps://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98
https://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
From the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
From the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
From the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1
... 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
... 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
... 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..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣC 0..* Identifier National Provider Identifier (NPI)
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:identifierSubDepartment 0..1 string Identifies a specific subdivision within the organization
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-identifierSubDepartment
...... extension:identifierJurisdiction 0..1 CodeableConcept State/jurisdiction where the NPI is registered
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-identifierJurisdiction
..... 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: NPI
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
..... 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 Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:TIN SΣC 0..1 Identifier The US Employer Identification Number (EIN) or Tax Identification Number (TIN).
..... 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... 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 Σ 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: TAX
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://terminology.hl7.org/NamingSystem/USEIN
..... 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 Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:PI SΣC 0..1 Identifier The Payer Identification Number (PI)
..... 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..* Coding Code defined by a terminology system
....... 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 Σ 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: payerid
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Complex
..... 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 Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
... type SΣ 0..* CodeableConcept Kind of organization
Binding: https://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98 (required)
... 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
Constraints: org-3
.... 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)
.... value SΣ 0..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... 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
Constraints: org-2
.... 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 ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
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
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:NPI.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Organization.identifier:NPI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Organization.identifier:TIN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Organization.identifier:TIN.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Organization.identifier:PI.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Organization.identifier:PI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Organization.typerequiredhttps://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98
https://valueset.x12.org/x12/005010/request/2010A/NM1/1/01/00/98
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
From the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
From the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
From the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
From the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from Organization

Summary

Mandatory: 2 elements(7 nested mandatory elements)
Must-Support: 18 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

The Interactions supported by this resource are listed below.