Consumer Real-Time Pharmacy Benefit Check FHIR IG
2.0.0 - CI Build United States of America flag

Consumer Real-Time Pharmacy Benefit Check FHIR IG, published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/carin-rtpbc/ and changes regularly. See the Directory of published versions

Resource Profile: RTPBC Pharmacy Organization

Official URL: http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-pharmacy-organization Version: 2.0.0
Standards status: Trial-use Active as of 2020-05-23 Maturity Level: 4 Computable Name: RtpbcPharmacy

This profile builds on the US Core Organization to represent a pharmacy as used in the real-time pharmacy benefit check (RTPBC) process.

The function of the Pharmacy resource in this exchange is to identify a pharmacy as either…

  • the patient's preferred pharmacy, in the RTPBC request
  • or an alternative pharmacy for which information is being returned in the RTPBC response

The set of conveyed pharmacy information consists of…

  • identification of the pharmacy. The NCPDP Provider Identification Number is the preferred identifier for this purpose because it specifies the individual pharmacy location. Alternatively, an organizational NPI may be used
  • the pharmacy name
  • the phone number
  • the pharmacy address

Must Support elements in this profile

Client systems

  • The pharmacy identifier and name MUST be populated with correct information in order for the processor to determine reliable cost and coverage information
  • Pharmacy phone and address SHOULD be populated to assist in identifying a particular pharmacy location, especially when identifying the pharmacy using an NPI

Responding systems

  • MUST consider pharmacy type and location when determining pricing, coverage, and alternative pharmacy options

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* USCoreOrganizationProfile 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 1..* Identifier Pharmacy Identifier
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:NPI SΣC 0..* Identifier National Provider Identifier (NPI)
Constraints: us-core-16, us-core-17

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)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:CLIA ΣC 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Constraints: us-core-18

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)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:NAIC ΣC 0..* Identifier NAIC Code
Constraints: us-core-19

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)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:NcpdpProviderId SΣC 0..1 Identifier NCPDP Provider ID

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/CodeSystem/NCPDPProviderIdentificationNumber
..... 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)
... type SΣ 1..1 CodeableConcept Pharmacy Type
Binding: RTPBC Pharmacy Type Value Set (extensible): RTPBC Pharmacy Type Value Set
... name SΣC 1..1 string Pharmacy Name
... telecom SC 0..* ContactPoint Pharmacy Telephone
Constraints: org-3
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
.... value SΣ 1..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 Pharmacy Address
Constraints: org-2
.... 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 US Core: 49 MEADOW ST
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: RTPBC Two Letter State and Province Code Value Set (extensible): RTPBC Two Letter State and Province Codes
Example US Core: OK
.... postalCode SΣ 0..1 string Postal code
Example General: 9132
Example US Core: 74047
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: RTPBC Country Code Value Set (required): ISO 3166 2-character country codes

doco 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:NPI.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:CLIA.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:NAIC.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.type Base extensible RTPBC Pharmacy Type Value Set 📦2.0.0 This IG
Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
Organization.address.​state Base extensible RTPBC Two Letter State and Province Code Value Set 📦2.0.0 This IG
Organization.address.​country Base required RTPBC Country Code Value Set 📦2.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
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()
us-core-16 error Organization.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
us-core-17 error Organization.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
us-core-18 error Organization.identifier:CLIA CLIA number must be 10 digits with a letter "D" in third position value.matches('^[0-9]{2}D[0-9]{7}$')
us-core-19 error Organization.identifier:NAIC NAIC must be 5 digits value.matches('^[0-9]{5}$')

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization 0..* USCoreOrganizationProfile A grouping of people or organizations with a common purpose
... identifier 1..* Identifier Pharmacy Identifier
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... Slices for identifier Content/Rules for all slices
.... identifier:NPI 0..* Identifier National Provider Identifier (NPI)
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... identifier:CLIA 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... identifier:NAIC 0..* Identifier NAIC Code
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... identifier:NcpdpProviderId S 0..1 Identifier NCPDP Provider ID
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber
... type S 1..1 CodeableConcept Pharmacy Type
Binding: RTPBC Pharmacy Type Value Set (extensible): RTPBC Pharmacy Type Value Set
... telecom 0..* ContactPoint Pharmacy Telephone
.... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
.... value 1..1 string The actual contact point details
... address 0..* Address Pharmacy Address
.... state 0..1 string Sub-unit of country (abbreviations ok)
Binding: RTPBC Two Letter State and Province Code Value Set (extensible): RTPBC Two Letter State and Province Codes
.... postalCode 0..1 string Postal code
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: RTPBC Country Code Value Set (required): ISO 3166 2-character country codes

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Organization.type Base extensible RTPBC Pharmacy Type Value Set 📦2.0.0 This IG
Organization.address.​state Base extensible RTPBC Two Letter State and Province Code Value Set 📦2.0.0 This IG
Organization.address.​country Base required RTPBC Country Code Value Set 📦2.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* USCoreOrganizationProfile 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 1..* Identifier Pharmacy Identifier
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..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:NPI SΣC 0..* Identifier National Provider Identifier (NPI)
Constraints: us-core-16, us-core-17

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)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..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:CLIA ΣC 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Constraints: us-core-18

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)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..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:NAIC ΣC 0..* Identifier NAIC Code
Constraints: us-core-19

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)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..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:NcpdpProviderId SΣC 0..1 Identifier NCPDP Provider ID

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/CodeSystem/NCPDPProviderIdentificationNumber
..... 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Σ 1..1 CodeableConcept Pharmacy Type
Binding: RTPBC Pharmacy Type Value Set (extensible): RTPBC Pharmacy Type Value Set
... name SΣC 1..1 string Pharmacy Name
... 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 Pharmacy Telephone
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 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
.... value SΣ 1..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 Pharmacy Address
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 ?!Σ 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 US Core: 49 MEADOW ST
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: RTPBC Two Letter State and Province Code Value Set (extensible): RTPBC Two Letter State and Province Codes
Example US Core: OK
.... postalCode SΣ 0..1 string Postal code
Example General: 9132
Example US Core: 74047
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: RTPBC Country Code Value Set (required): ISO 3166 2-character country codes
.... 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

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 extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:NPI.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:NPI.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:CLIA.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:CLIA.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:NAIC.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:NAIC.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.type Base extensible RTPBC Pharmacy Type Value Set 📦2.0.0 This IG
Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
Organization.address.​type Base required AddressType 📍4.0.1 FHIR Std.
Organization.address.​state Base extensible RTPBC Two Letter State and Province Code Value Set 📦2.0.0 This IG
Organization.address.​country Base required RTPBC Country Code Value Set 📦2.0.0 This IG
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()
us-core-16 error Organization.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
us-core-17 error Organization.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
us-core-18 error Organization.identifier:CLIA CLIA number must be 10 digits with a letter "D" in third position value.matches('^[0-9]{2}D[0-9]{7}$')
us-core-19 error Organization.identifier:NAIC NAIC must be 5 digits value.matches('^[0-9]{5}$')

Summary

Mandatory: 4 elements(8 nested mandatory elements)
Must-Support: 2 elements
Fixed: 1 element

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* USCoreOrganizationProfile 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 1..* Identifier Pharmacy Identifier
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:NPI SΣC 0..* Identifier National Provider Identifier (NPI)
Constraints: us-core-16, us-core-17

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)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:CLIA ΣC 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Constraints: us-core-18

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)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:NAIC ΣC 0..* Identifier NAIC Code
Constraints: us-core-19

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)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:NcpdpProviderId SΣC 0..1 Identifier NCPDP Provider ID

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/CodeSystem/NCPDPProviderIdentificationNumber
..... 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)
... type SΣ 1..1 CodeableConcept Pharmacy Type
Binding: RTPBC Pharmacy Type Value Set (extensible): RTPBC Pharmacy Type Value Set
... name SΣC 1..1 string Pharmacy Name
... telecom SC 0..* ContactPoint Pharmacy Telephone
Constraints: org-3
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
.... value SΣ 1..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 Pharmacy Address
Constraints: org-2
.... 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 US Core: 49 MEADOW ST
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: RTPBC Two Letter State and Province Code Value Set (extensible): RTPBC Two Letter State and Province Codes
Example US Core: OK
.... postalCode SΣ 0..1 string Postal code
Example General: 9132
Example US Core: 74047
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: RTPBC Country Code Value Set (required): ISO 3166 2-character country codes

doco 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:NPI.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:CLIA.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:NAIC.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.type Base extensible RTPBC Pharmacy Type Value Set 📦2.0.0 This IG
Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
Organization.address.​state Base extensible RTPBC Two Letter State and Province Code Value Set 📦2.0.0 This IG
Organization.address.​country Base required RTPBC Country Code Value Set 📦2.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
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()
us-core-16 error Organization.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
us-core-17 error Organization.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
us-core-18 error Organization.identifier:CLIA CLIA number must be 10 digits with a letter "D" in third position value.matches('^[0-9]{2}D[0-9]{7}$')
us-core-19 error Organization.identifier:NAIC NAIC must be 5 digits value.matches('^[0-9]{5}$')

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization 0..* USCoreOrganizationProfile A grouping of people or organizations with a common purpose
... identifier 1..* Identifier Pharmacy Identifier
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... Slices for identifier Content/Rules for all slices
.... identifier:NPI 0..* Identifier National Provider Identifier (NPI)
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... identifier:CLIA 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... identifier:NAIC 0..* Identifier NAIC Code
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
.... identifier:NcpdpProviderId S 0..1 Identifier NCPDP Provider ID
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber
... type S 1..1 CodeableConcept Pharmacy Type
Binding: RTPBC Pharmacy Type Value Set (extensible): RTPBC Pharmacy Type Value Set
... telecom 0..* ContactPoint Pharmacy Telephone
.... system 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
.... value 1..1 string The actual contact point details
... address 0..* Address Pharmacy Address
.... state 0..1 string Sub-unit of country (abbreviations ok)
Binding: RTPBC Two Letter State and Province Code Value Set (extensible): RTPBC Two Letter State and Province Codes
.... postalCode 0..1 string Postal code
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: RTPBC Country Code Value Set (required): ISO 3166 2-character country codes

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Organization.type Base extensible RTPBC Pharmacy Type Value Set 📦2.0.0 This IG
Organization.address.​state Base extensible RTPBC Two Letter State and Province Code Value Set 📦2.0.0 This IG
Organization.address.​country Base required RTPBC Country Code Value Set 📦2.0.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* USCoreOrganizationProfile 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 1..* Identifier Pharmacy Identifier
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..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:NPI SΣC 0..* Identifier National Provider Identifier (NPI)
Constraints: us-core-16, us-core-17

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)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..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:CLIA ΣC 0..* Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Constraints: us-core-18

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)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..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:NAIC ΣC 0..* Identifier NAIC Code
Constraints: us-core-19

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)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..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:NcpdpProviderId SΣC 0..1 Identifier NCPDP Provider ID

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/CodeSystem/NCPDPProviderIdentificationNumber
..... 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Σ 1..1 CodeableConcept Pharmacy Type
Binding: RTPBC Pharmacy Type Value Set (extensible): RTPBC Pharmacy Type Value Set
... name SΣC 1..1 string Pharmacy Name
... 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 Pharmacy Telephone
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 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Fixed Value: phone
.... value SΣ 1..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 Pharmacy Address
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 ?!Σ 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 US Core: 49 MEADOW ST
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: RTPBC Two Letter State and Province Code Value Set (extensible): RTPBC Two Letter State and Province Codes
Example US Core: OK
.... postalCode SΣ 0..1 string Postal code
Example General: 9132
Example US Core: 74047
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: RTPBC Country Code Value Set (required): ISO 3166 2-character country codes
.... 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

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 extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:NPI.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:NPI.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:CLIA.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:CLIA.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.identifier:NAIC.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Organization.identifier:NAIC.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Organization.type Base extensible RTPBC Pharmacy Type Value Set 📦2.0.0 This IG
Organization.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Organization.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Organization.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
Organization.address.​type Base required AddressType 📍4.0.1 FHIR Std.
Organization.address.​state Base extensible RTPBC Two Letter State and Province Code Value Set 📦2.0.0 This IG
Organization.address.​country Base required RTPBC Country Code Value Set 📦2.0.0 This IG
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()
us-core-16 error Organization.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
us-core-17 error Organization.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
us-core-18 error Organization.identifier:CLIA CLIA number must be 10 digits with a letter "D" in third position value.matches('^[0-9]{2}D[0-9]{7}$')
us-core-19 error Organization.identifier:NAIC NAIC must be 5 digits value.matches('^[0-9]{5}$')

Summary

Mandatory: 4 elements(8 nested mandatory elements)
Must-Support: 2 elements
Fixed: 1 element

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron