US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401 United States of America flag

Publication Build: This will be filled in by the publication tooling

Resource Profile: Organization

Official URL: http://va.gov/fhir/StructureDefinition/Organization Version: 1.3.1
Active as of 2025-03-31 Computable Name: Organization

This StructureDefinition contains the maps for VistA file INSTITUTION (4) to us-core-organization.

See also the FHIR Shorthand.

Use Case Overview

Use Case: Organization«us-core-organization»Organization

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* USCoreOrganizationProfile(5.0.1) A grouping of people or organizations with a common purpose
This profile also complies with the profiles US Core Organization Profile (6.1.0) and US Core Organization Profile (7.0.0)
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier SΣC 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
ele-1: All FHIR elements must have a @value or children
.... identifier:NPI SΣC 0..1 Identifier National Provider Identifier (NPI)
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system Σ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://hl7.org/fhir/sid/us-npi
..... value Σ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:CLIA ΣC 0..1 Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
... type SΣ 0..* CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: prov
... name SΣC 1..1 string Name used for the organization
ele-1: All FHIR elements must have a @value or children
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
ele-1: All FHIR elements must have a @value or children
... telecom SC 0..* ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
... Slices for address SC 0..* Address An address for the organization
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'
.... address:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
..... line SΣ 0..4 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


ele-1: All FHIR elements must have a @value or children
..... postalCode SΣ 0..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
ele-1: All FHIR elements must have a @value or children
.... address:va-physical SC 0..1 Address An address for the organization
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


ele-1: All FHIR elements must have a @value or children
Required Pattern: physical
..... line SΣ 0..4 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
..... district SΣ 0..1 string District name (aka county)
ele-1: All FHIR elements must have a @value or children
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


ele-1: All FHIR elements must have a @value or children
..... postalCode SΣ 0..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
ele-1: All FHIR elements must have a @value or children
.... address:va-postal SC 0..1 Address An address for the organization
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


ele-1: All FHIR elements must have a @value or children
Required Pattern: postal
..... line SΣ 0..4 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


ele-1: All FHIR elements must have a @value or children
..... postalCode SΣ 0..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
ele-1: All FHIR elements must have a @value or children
... contact 0..* BackboneElement Contact for the organization for a certain purpose
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... name 0..1 HumanName A name associated with the contact
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


ele-1: All FHIR elements must have a @value or children
..... text SΣ 0..1 string Text representation of the full name
ele-1: All FHIR elements must have a @value or children
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
ele-1: All FHIR elements must have a @value or children
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: phone
..... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.identifier:NPI.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.typeexamplePattern: prov
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.address:va-physical.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:va-physical.typerequiredPattern: physical
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address:va-physical.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.address:va-postal.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:va-postal.typerequiredPattern: postal
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address:va-postal.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Organization.contact.telecom.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Constraints

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

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization USCoreOrganizationProfile(5.0.1) This profile also complies with the profiles US Core Organization Profile (6.1.0) and US Core Organization Profile (7.0.0)
... Slices for identifier Content/Rules for all slices
.... identifier:NPI 0..1 Identifier National Provider Identifier (NPI)
..... system 0..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
..... value 0..1 string The value that is unique
... active 1..1 boolean Whether the organization's record is still in active use
Required Pattern: true
... type S 0..* CodeableConcept Kind of organization
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: prov
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom 0..* ContactPoint A contact detail for the organization
... Slices for address 0..* Address An address for the organization
Slice: Unordered, Open by value:$this
.... address:va-physical 0..1 Address An address for the organization
..... type S 0..1 code postal | physical | both
Required Pattern: physical
..... line 0..4 string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district S 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string US Zip Codes
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... address:va-postal 0..1 Address An address for the organization
..... type S 0..1 code postal | physical | both
Required Pattern: postal
..... line 0..4 string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string US Zip Codes
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... contact
.... name
..... text S 0..1 string Text representation of the full name
.... telecom
..... system S 0..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value S 0..1 string The actual contact point details

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* USCoreOrganizationProfile(5.0.1) A grouping of people or organizations with a common purpose
This profile also complies with the profiles US Core Organization Profile (6.1.0) and US Core Organization Profile (7.0.0)
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣC 0..1 Identifier National Provider Identifier (NPI)

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 Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:CLIA ΣC 0..1 Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories

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)
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
Required Pattern: true
... type SΣ 0..* CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.



Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: prov
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... name SΣC 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom SC 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... Slices for address SC 0..* Address An address for the organization
Slice: Unordered, Open by value:$this
org-2: An address of an organization can never be of use 'home'
.... address: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 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
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:va-physical SC 0..1 Address An address for the organization
org-2: An address of an organization can never be of use 'home'
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Required Pattern: physical
..... 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
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district SΣ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:va-postal SC 0..1 Address An address for the organization
org-2: An address of an organization can never be of use 'home'
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Required Pattern: postal
..... 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
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact 0..* BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1 HumanName A name associated with the contact
..... 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 | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text SΣ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 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

PathConformanceValueSet / CodeURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:NPI.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:NPI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeexamplePattern: prov
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.address:va-physical.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:va-physical.typerequiredPattern: physical
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address:va-physical.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.address:va-postal.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:va-postal.typerequiredPattern: postal
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address:va-postal.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard
Organization.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Organization.contact.telecom.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Constraints

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

This structure is derived from USCoreOrganizationProfile

Summary

Must-Support: 8 elements

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* USCoreOrganizationProfile(5.0.1) A grouping of people or organizations with a common purpose
This profile also complies with the profiles US Core Organization Profile (6.1.0) and US Core Organization Profile (7.0.0)
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier SΣC 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
ele-1: All FHIR elements must have a @value or children
.... identifier:NPI SΣC 0..1 Identifier National Provider Identifier (NPI)
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... system Σ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Required Pattern: http://hl7.org/fhir/sid/us-npi
..... value Σ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:CLIA ΣC 0..1 Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories
ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
... type SΣ 0..* CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: prov
... name SΣC 1..1 string Name used for the organization
ele-1: All FHIR elements must have a @value or children
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
ele-1: All FHIR elements must have a @value or children
... telecom SC 0..* ContactPoint A contact detail for the organization
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
... Slices for address SC 0..* Address An address for the organization
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'
.... address:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
..... line SΣ 0..4 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


ele-1: All FHIR elements must have a @value or children
..... postalCode SΣ 0..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
ele-1: All FHIR elements must have a @value or children
.... address:va-physical SC 0..1 Address An address for the organization
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


ele-1: All FHIR elements must have a @value or children
Required Pattern: physical
..... line SΣ 0..4 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
..... district SΣ 0..1 string District name (aka county)
ele-1: All FHIR elements must have a @value or children
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


ele-1: All FHIR elements must have a @value or children
..... postalCode SΣ 0..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
ele-1: All FHIR elements must have a @value or children
.... address:va-postal SC 0..1 Address An address for the organization
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


ele-1: All FHIR elements must have a @value or children
Required Pattern: postal
..... line SΣ 0..4 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


ele-1: All FHIR elements must have a @value or children
..... postalCode SΣ 0..1 string US Zip Codes
ele-1: All FHIR elements must have a @value or children
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
ele-1: All FHIR elements must have a @value or children
... contact 0..* BackboneElement Contact for the organization for a certain purpose
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... name 0..1 HumanName A name associated with the contact
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


ele-1: All FHIR elements must have a @value or children
..... text SΣ 0..1 string Text representation of the full name
ele-1: All FHIR elements must have a @value or children
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
ele-1: All FHIR elements must have a @value or children
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
Required Pattern: phone
..... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organization.identifier:NPI.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.typeexamplePattern: prov
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.address:va-physical.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:va-physical.typerequiredPattern: physical
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address:va-physical.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.address:va-postal.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:va-postal.typerequiredPattern: postal
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address:va-postal.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Organization.contact.telecom.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Constraints

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

Differential View

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization USCoreOrganizationProfile(5.0.1) This profile also complies with the profiles US Core Organization Profile (6.1.0) and US Core Organization Profile (7.0.0)
... Slices for identifier Content/Rules for all slices
.... identifier:NPI 0..1 Identifier National Provider Identifier (NPI)
..... system 0..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
..... value 0..1 string The value that is unique
... active 1..1 boolean Whether the organization's record is still in active use
Required Pattern: true
... type S 0..* CodeableConcept Kind of organization
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: prov
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom 0..* ContactPoint A contact detail for the organization
... Slices for address 0..* Address An address for the organization
Slice: Unordered, Open by value:$this
.... address:va-physical 0..1 Address An address for the organization
..... type S 0..1 code postal | physical | both
Required Pattern: physical
..... line 0..4 string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district S 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string US Zip Codes
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... address:va-postal 0..1 Address An address for the organization
..... type S 0..1 code postal | physical | both
Required Pattern: postal
..... line 0..4 string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string US Zip Codes
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... contact
.... name
..... text S 0..1 string Text representation of the full name
.... telecom
..... system S 0..1 code phone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value S 0..1 string The actual contact point details

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* USCoreOrganizationProfile(5.0.1) A grouping of people or organizations with a common purpose
This profile also complies with the profiles US Core Organization Profile (6.1.0) and US Core Organization Profile (7.0.0)
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 0..* Identifier Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:NPI SΣC 0..1 Identifier National Provider Identifier (NPI)

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 Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-npi
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:CLIA ΣC 0..1 Identifier Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories

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)
... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
Required Pattern: true
... type SΣ 0..* CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.



Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/organization-type
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: prov
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... name SΣC 1..1 string Name used for the organization
... alias S 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom SC 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... Slices for address SC 0..* Address An address for the organization
Slice: Unordered, Open by value:$this
org-2: An address of an organization can never be of use 'home'
.... address: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 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
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:va-physical SC 0..1 Address An address for the organization
org-2: An address of an organization can never be of use 'home'
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Required Pattern: physical
..... 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
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district SΣ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:va-postal SC 0..1 Address An address for the organization
org-2: An address of an organization can never be of use 'home'
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Required Pattern: postal
..... 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
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact 0..* BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1 HumanName A name associated with the contact
..... 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 | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text SΣ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name (often called 'Surname')
..... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 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

PathConformanceValueSet / CodeURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:NPI.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier:NPI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeexamplePattern: prov
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.address:va-physical.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:va-physical.typerequiredPattern: physical
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address:va-physical.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.address:va-postal.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address:va-postal.typerequiredPattern: postal
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address:va-postal.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard
Organization.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Organization.contact.telecom.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Constraints

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

This structure is derived from USCoreOrganizationProfile

Summary

Must-Support: 8 elements

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron