US Prescription Drug Monitoring Program (PDMP), published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-pdmp/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-organization-pharmacy | Version: 1.0.0 | |||
Active as of 2024-04-01 | Computable Name: PdmpOrganizationPharmacy | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.35.42.16 |
Defines constraints and extensions on the Organization resource when used by a Prescription Drug Monitoring Program (PDMP) to represent a dispensing pharmacy.
Important elements in this profile:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreOrganizationProfile
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose | |
![]() ![]() ![]() |
1..* | Identifier | Identifies this organization across multiple systems | |
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | NCPDP Provider ID Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | DEA Number Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/usdeanumber | |
![]() ![]() ![]() |
1..1 | string | Name used for the organization | |
![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the organization | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..4 | string | Street name, number, direction & P.O. Box etc. | |
![]() ![]() ![]() ![]() |
0..1 | string | Name of city, town etc. | |
![]() ![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok) | |
![]() ![]() ![]() ![]() |
0..1 | string | US Zip Codes | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣC | 0..* | Identifier | National Provider Identifier (NPI) 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 |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories us-core-18: CLIA number must be 10 digits with a letter "D" in third position Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | Identifier | NAIC Code us-core-19: NAIC must be 5 digits Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | NCPDP Provider ID Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber | |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | DEA Number Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/usdeanumber | |
![]() ![]() ![]() |
?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() ![]() |
SΣC | 1..1 | string | Name used for the organization |
![]() ![]() ![]() |
SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() |
SC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
![]() |
Path | Conformance | ValueSet | URI |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
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 |
Id | Grade | Path(s) | Details | Requirements |
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}$') |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..* | Identifier | National Provider Identifier (NPI) 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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories us-core-18: CLIA number must be 10 digits with a letter "D" in third position Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | Identifier | NAIC Code us-core-19: NAIC must be 5 digits Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | NCPDP Provider ID Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | DEA Number Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/usdeanumber | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name used for the organization | ||||
![]() ![]() ![]() |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
![]() ![]() ![]() |
SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
SC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | |||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
![]() ![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | |||||
![]() ![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Organization.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-type from the FHIR Standard | ||||
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 |
Id | Grade | Path(s) | Details | Requirements |
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}$') |
This structure is derived from USCoreOrganizationProfile
Differential View
This structure is derived from USCoreOrganizationProfile
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose | |
![]() ![]() ![]() |
1..* | Identifier | Identifies this organization across multiple systems | |
![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | NCPDP Provider ID Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | DEA Number Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/usdeanumber | |
![]() ![]() ![]() |
1..1 | string | Name used for the organization | |
![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the organization | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..4 | string | Street name, number, direction & P.O. Box etc. | |
![]() ![]() ![]() ![]() |
0..1 | string | Name of city, town etc. | |
![]() ![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok) | |
![]() ![]() ![]() ![]() |
0..1 | string | US Zip Codes | |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣC | 0..* | Identifier | National Provider Identifier (NPI) 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 |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories us-core-18: CLIA number must be 10 digits with a letter "D" in third position Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | Identifier | NAIC Code us-core-19: NAIC must be 5 digits Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | NCPDP Provider ID Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber | |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | DEA Number Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/usdeanumber | |
![]() ![]() ![]() |
?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() ![]() |
SΣC | 1..1 | string | Name used for the organization |
![]() ![]() ![]() |
SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() |
SC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
![]() |
Path | Conformance | ValueSet | URI |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
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 |
Id | Grade | Path(s) | Details | Requirements |
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}$') |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣC | 1..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..* | Identifier | National Provider Identifier (NPI) 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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories us-core-18: CLIA number must be 10 digits with a letter "D" in third position Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | Identifier | NAIC Code us-core-19: NAIC must be 5 digits Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.6.300 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | NCPDP Provider ID Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/CodeSystem/NCPDPProviderIdentificationNumber | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | DEA Number Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: http://terminology.hl7.org/NamingSystem/usdeanumber | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | The value that is unique | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name used for the organization | ||||
![]() ![]() ![]() |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
![]() ![]() ![]() |
SC | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
SC | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | |||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
![]() ![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | |||||
![]() ![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Organization.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-type from the FHIR Standard | ||||
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 |
Id | Grade | Path(s) | Details | Requirements |
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}$') |
This structure is derived from USCoreOrganizationProfile
Other representations of profile: CSV, Excel, Schematron