This page is part of the Da Vinci Prior Authorization Support (PAS) FHIR IG (v2.1.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.1. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-insurer | Version: 2.1.0-preview | |||
Standards status: Trial-use | Maturity Level: 3 | Computable Name: PASInsurer |
An organization who provides insurance and is the receiver of a prior authorization request.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PASOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | PASOrganization | This profile also complies with the profiles US Core Organization Profile (3.1.1) and US Core Organization Profile (6.1.0) | ||
type | S | 0..* | CodeableConcept | Kind of organization Binding: https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98 (required): Codes identifying an organizational entity, a physical location, property or an individual. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type | required | https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | PASOrganization | A grouping of people or organizations with a common purpose This profile also complies with the profiles US Core Organization Profile (3.1.1) and US Core Organization Profile (6.1.0) org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣC | 0..* | PASIdentifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
identifier:NPI | SC | 0..* | PASIdentifier | An identifier intended for computation us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
identifier:CLIA | C | 0..* | PASIdentifier | An identifier intended for computation us-core-18: CLIA number must be 10 digits with a letter "D" in third position Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |
identifier:NAIC | C | 0..* | PASIdentifier | An identifier intended for computation us-core-19: NAIC must be 5 digits Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |
identifier:TIN | SΣC | 0..1 | Identifier | The US Employer Identification Number (EIN) or Tax Identification Number (TIN). Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/USEIN | |
identifier:PI | SΣC | 0..1 | Identifier | The Payer Identification Number (PI) Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: payerid | |
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/x217/005010/request/2010A/NM1/1/01/00/98 (required): Codes identifying an organizational entity, a physical location, property or an individual. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. |
name | SΣC | 1..1 | string | Name used for the organization |
telecom | SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | SΣ | 0..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
address | SC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example General: 49 MEADOW ST |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN |
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example General: OK |
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example General: 74047 |
country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type | required | https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98 | |
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Organization.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ )http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | PASOrganization | A grouping of people or organizations with a common purpose This profile also complies with the profiles US Core Organization Profile (3.1.1) and US Core Organization Profile (6.1.0) org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣC | 0..* | PASIdentifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
identifier:NPI | SC | 0..* | PASIdentifier | An identifier intended for computation us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
value | 0..1 | string | The value that is unique | |||||
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:CLIA | C | 0..* | PASIdentifier | An identifier intended for computation us-core-18: CLIA number must be 10 digits with a letter "D" in third position Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |||||
value | 0..1 | string | The value that is unique | |||||
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:NAIC | C | 0..* | PASIdentifier | An identifier intended for computation us-core-19: NAIC must be 5 digits Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |||||
value | 0..1 | string | The value that is unique | |||||
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). Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/USEIN | |||||
value | 0..1 | string | The value that is unique | |||||
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) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: 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 Fixed Value: 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 | |||||
system | 0..1 | uri | The namespace for the identifier value | |||||
value | 0..1 | string | The value that is unique | |||||
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/x217/005010/request/2010A/NM1/1/01/00/98 (required): Codes identifying an organizational entity, a physical location, property or an individual. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
telecom | SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | SΣ | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
address | SC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example General: 49 MEADOW ST | ||||
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN | ||||
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): Two letter USPS alphabetic codes. Example General: OK | ||||
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example General: 74047 | ||||
country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
name | 0..1 | HumanName | A name associated with the contact | |||||
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Organization.type | required | https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98 | ||||
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Organization.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Organization.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ )http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard |
This structure is derived from PASOrganization
Differential View
This structure is derived from PASOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | PASOrganization | This profile also complies with the profiles US Core Organization Profile (3.1.1) and US Core Organization Profile (6.1.0) | ||
type | S | 0..* | CodeableConcept | Kind of organization Binding: https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98 (required): Codes identifying an organizational entity, a physical location, property or an individual. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type | required | https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | PASOrganization | A grouping of people or organizations with a common purpose This profile also complies with the profiles US Core Organization Profile (3.1.1) and US Core Organization Profile (6.1.0) org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | SΣC | 0..* | PASIdentifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
identifier:NPI | SC | 0..* | PASIdentifier | An identifier intended for computation us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
identifier:CLIA | C | 0..* | PASIdentifier | An identifier intended for computation us-core-18: CLIA number must be 10 digits with a letter "D" in third position Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |
identifier:NAIC | C | 0..* | PASIdentifier | An identifier intended for computation us-core-19: NAIC must be 5 digits Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |
identifier:TIN | SΣC | 0..1 | Identifier | The US Employer Identification Number (EIN) or Tax Identification Number (TIN). Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/USEIN | |
identifier:PI | SΣC | 0..1 | Identifier | The Payer Identification Number (PI) Required Pattern: At least the following |
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: payerid | |
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/x217/005010/request/2010A/NM1/1/01/00/98 (required): Codes identifying an organizational entity, a physical location, property or an individual. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. |
name | SΣC | 1..1 | string | Name used for the organization |
telecom | SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | SΣ | 0..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
address | SC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example General: 49 MEADOW ST |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN |
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example General: OK |
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example General: 74047 |
country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.type | required | https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98 | |
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
Organization.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ )http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | PASOrganization | A grouping of people or organizations with a common purpose This profile also complies with the profiles US Core Organization Profile (3.1.1) and US Core Organization Profile (6.1.0) org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣC | 0..* | PASIdentifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
identifier:NPI | SC | 0..* | PASIdentifier | An identifier intended for computation us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
value | 0..1 | string | The value that is unique | |||||
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:CLIA | C | 0..* | PASIdentifier | An identifier intended for computation us-core-18: CLIA number must be 10 digits with a letter "D" in third position Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |||||
value | 0..1 | string | The value that is unique | |||||
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:NAIC | C | 0..* | PASIdentifier | An identifier intended for computation us-core-19: NAIC must be 5 digits Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |||||
value | 0..1 | string | The value that is unique | |||||
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). Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 0..1 | CodeableConcept | Description of identifier | |||||
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/USEIN | |||||
value | 0..1 | string | The value that is unique | |||||
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) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
type | 1..1 | CodeableConcept | Description of identifier Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: 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 Fixed Value: 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 | |||||
system | 0..1 | uri | The namespace for the identifier value | |||||
value | 0..1 | string | The value that is unique | |||||
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/x217/005010/request/2010A/NM1/1/01/00/98 (required): Codes identifying an organizational entity, a physical location, property or an individual. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions. | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
telecom | SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | SΣ | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
address | SC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example General: 49 MEADOW ST | ||||
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN | ||||
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): Two letter USPS alphabetic codes. Example General: OK | ||||
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example General: 74047 | ||||
country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
name | 0..1 | HumanName | A name associated with the contact | |||||
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Organization.type | required | https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98https://valueset.x12.org/x217/005010/request/2010A/NM1/1/01/00/98 | ||||
Organization.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Organization.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Organization.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Organization.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/ )http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-type from the FHIR Standard |
This structure is derived from PASOrganization
Other representations of profile: CSV, Excel, Schematron