US Core Implementation Guide
8.0.0-ballot - Ballot United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 8.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Resource Profile: US Core Organization Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization Version: 8.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: USCoreOrganizationProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.48

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

The US Core Organization Profile inherits from the FHIR Organization resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Organization resource to record, search, and fetch patient or provider organziation information. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for this profile:

  • Query by organization name or NPI

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Organization Must Have:

  1. A status of the organization (i.e., whether it is still active )
  2. A name

Each Organization Must Support:

  1. An identifier*
  2. A list of contact information
  3. An address*

*see guidance below

Profile Specific Implementation Guidance:

  • *Systems SHALL support National Provider Identifier (NPI) for organizations and SHOULD support Clinical Laboratory Improvement Amendments (CLIA) for laboratories and the National Association of Insurance Commissioners NAIC Company code (sometimes called "NAIC Number" or "cocode") for payers.
  • * Systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for Organization.address.line and  Organization.address.city.

Usage:

Changes since version 7.0.0:

  • No changes
  • Formal Views of Profile Content

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

    This structure is derived from Organization

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Organization 0..* Organization A grouping of people or organizations with a common purpose
    ... Slices for identifier S 0..* Identifier Identifies this organization across multiple systems
    Slice: Unordered, Open by value:$this
    .... identifier:All Slices Content/Rules for all slices
    ..... system S 0..1 uri The namespace for the identifier value
    ..... value S 0..1 string The value that is unique
    .... identifier:NPI SC 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
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org/fhir/sid/us-npi
    .... identifier:CLIA 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
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: urn:oid:2.16.840.1.113883.4.7
    .... identifier:NAIC C 0..* Identifier NAIC Code
    us-core-19: NAIC must be 5 digits
    Required Pattern: At least the following
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: urn:oid:2.16.840.1.113883.6.300
    ... active S 1..1 boolean Whether the organization's record is still in active use
    ... name S 1..1 string Name used for the organization
    ... telecom S 0..* ContactPoint A contact detail for the organization
    .... system S 0..1 code phone | fax | email | pager | url | sms | other
    .... value S 0..1 string The actual contact point details
    ... address S 0..* Address An address for the organization
    .... line S 0..4 string Street name, number, direction & P.O. Box etc.
    Example General: 49 MEADOW ST
    .... city S 0..1 string Name of city, town etc.
    Example General: EVERYTOWN
    .... state S 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


    Example General: OK
    .... postalCode S 0..1 string US Zip Codes
    Example General: 74047
    .... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
    http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
    from this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    us-core-16errorOrganization.identifier:NPINPI must be 10 digits
    : value.matches('^[0-9]{10}$')
    us-core-17errorOrganization.identifier:NPINPI 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-18errorOrganization.identifier:CLIACLIA number must be 10 digits with a letter "D" in third position
    : value.matches('^[0-9]{2}D[0-9]{7}$')
    us-core-19errorOrganization.identifier:NAICNAIC must be 5 digits
    : value.matches('^[0-9]{5}$')
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Organization C 0..* Organization 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
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... Slices for identifier SΣC 0..* Identifier Identifies this organization across multiple systems
    Slice: Unordered, Open by value:$this
    .... identifier:All Slices Content/Rules for all slices
    ..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    ..... system SΣ 0..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    ..... value SΣ 0..1 string The value that is unique
    Example General: 123456
    .... identifier:NPI 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
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org/fhir/sid/us-npi
    .... identifier:CLIA Σ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
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: urn:oid:2.16.840.1.113883.4.7
    .... identifier:NAIC ΣC 0..* Identifier NAIC Code
    us-core-19: NAIC must be 5 digits

    Required Pattern: At least the following
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: urn:oid:2.16.840.1.113883.6.300
    ... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
    ... name SΣC 1..1 string Name used for the organization
    ... telecom SC 0..* ContactPoint A contact detail for the organization
    org-3: The telecom of an organization can never be of use 'home'
    .... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

    ... address SC 0..* Address An address for the organization
    org-2: An address of an organization can never be of use 'home'
    .... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.


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


    Example General: OK
    .... postalCode SΣ 0..1 string US Zip Codes
    Example General: 9132
    Example General: 74047
    .... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Organization.identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    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
    from this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    us-core-16errorOrganization.identifier:NPINPI must be 10 digits
    : value.matches('^[0-9]{10}$')
    us-core-17errorOrganization.identifier:NPINPI 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-18errorOrganization.identifier:CLIACLIA number must be 10 digits with a letter "D" in third position
    : value.matches('^[0-9]{2}D[0-9]{7}$')
    us-core-19errorOrganization.identifier:NAICNAIC must be 5 digits
    : value.matches('^[0-9]{5}$')
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Organization C 0..* Organization 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
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.

    Additional BindingsPurpose
    AllLanguages Max Binding
    ... 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 value:$this
    .... identifier:All Slices Content/Rules for all slices
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    ..... type Σ 0..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    ..... system SΣ 0..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    ..... value SΣ 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:NPI 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
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... use 0..1 code usual | official | temp | secondary | old (If known)
    ..... type 0..1 CodeableConcept Description of identifier
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org/fhir/sid/us-npi
    ..... value 0..1 string The value that is unique
    ..... period 0..1 Period Time period when id is/was valid for use
    ..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
    .... identifier:CLIA ΣC 0..* 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
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... use 0..1 code usual | official | temp | secondary | old (If known)
    ..... type 0..1 CodeableConcept Description of identifier
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: urn:oid:2.16.840.1.113883.4.7
    ..... value 0..1 string The value that is unique
    ..... period 0..1 Period Time period when id is/was valid for use
    ..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
    .... identifier:NAIC ΣC 0..* Identifier NAIC Code
    us-core-19: NAIC must be 5 digits

    Required Pattern: At least the following
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... use 0..1 code usual | official | temp | secondary | old (If known)
    ..... type 0..1 CodeableConcept Description of identifier
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: urn:oid:2.16.840.1.113883.6.300
    ..... value 0..1 string The value that is unique
    ..... period 0..1 Period Time period when id is/was valid for use
    ..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
    ... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
    ... type Σ 0..* CodeableConcept Kind of organization
    Binding: OrganizationType (example): Used to categorize the organization.


    ... name SΣC 1..1 string Name used for the organization
    ... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
    ... telecom SC 0..* ContactPoint A contact detail for the organization
    org-3: The telecom of an organization can never be of use 'home'
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

    .... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
    .... period Σ 0..1 Period Time period when the contact point was/is in use
    ... address SC 0..* Address An address for the organization
    org-2: An address of an organization can never be of use 'home'
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.


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


    Example General: both
    .... text Σ 0..1 string Text representation of the address
    Example General: 137 Nowhere Street, Erewhon 9132
    .... line SΣ 0..4 string Street name, number, direction & P.O. Box etc.
    This repeating element order: The order in which lines should appear in an address label
    Example General: 137 Nowhere Street
    Example General: 49 MEADOW ST
    .... city SΣ 0..1 string Name of city, town etc.
    Example General: Erewhon
    Example General: EVERYTOWN
    .... district Σ 0..1 string District name (aka county)
    Example General: Madison
    .... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


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

    .... name 0..1 HumanName A name associated with the contact
    .... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
    .... address 0..1 Address Visiting or postal addresses for the contact
    ... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Organization.languagepreferredCommonLanguages
    Additional Bindings Purpose
    AllLanguages Max Binding
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Organization.identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Organization.identifier.typeextensibleIdentifier Type Codes
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard
    Organization.typeexampleOrganizationType
    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
    from this IG
    Organization.contact.purposeextensibleContactEntityType
    http://hl7.org/fhir/ValueSet/contactentity-type
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    us-core-16errorOrganization.identifier:NPINPI must be 10 digits
    : value.matches('^[0-9]{10}$')
    us-core-17errorOrganization.identifier:NPINPI 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-18errorOrganization.identifier:CLIACLIA number must be 10 digits with a letter "D" in third position
    : value.matches('^[0-9]{2}D[0-9]{7}$')
    us-core-19errorOrganization.identifier:NAICNAIC must be 5 digits
    : value.matches('^[0-9]{5}$')

    This structure is derived from Organization

    Summary

    Mandatory: 2 elements
    Must-Support: 15 elements

    Slices

    This structure defines the following Slices:

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

    Maturity: 3

    Differential View

    This structure is derived from Organization

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Organization 0..* Organization A grouping of people or organizations with a common purpose
    ... Slices for identifier S 0..* Identifier Identifies this organization across multiple systems
    Slice: Unordered, Open by value:$this
    .... identifier:All Slices Content/Rules for all slices
    ..... system S 0..1 uri The namespace for the identifier value
    ..... value S 0..1 string The value that is unique
    .... identifier:NPI SC 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
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org/fhir/sid/us-npi
    .... identifier:CLIA 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
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: urn:oid:2.16.840.1.113883.4.7
    .... identifier:NAIC C 0..* Identifier NAIC Code
    us-core-19: NAIC must be 5 digits
    Required Pattern: At least the following
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: urn:oid:2.16.840.1.113883.6.300
    ... active S 1..1 boolean Whether the organization's record is still in active use
    ... name S 1..1 string Name used for the organization
    ... telecom S 0..* ContactPoint A contact detail for the organization
    .... system S 0..1 code phone | fax | email | pager | url | sms | other
    .... value S 0..1 string The actual contact point details
    ... address S 0..* Address An address for the organization
    .... line S 0..4 string Street name, number, direction & P.O. Box etc.
    Example General: 49 MEADOW ST
    .... city S 0..1 string Name of city, town etc.
    Example General: EVERYTOWN
    .... state S 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


    Example General: OK
    .... postalCode S 0..1 string US Zip Codes
    Example General: 74047
    .... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

    doco Documentation for this format

    Terminology Bindings (Differential)

    PathConformanceValueSetURI
    Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
    http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
    from this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    us-core-16errorOrganization.identifier:NPINPI must be 10 digits
    : value.matches('^[0-9]{10}$')
    us-core-17errorOrganization.identifier:NPINPI 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-18errorOrganization.identifier:CLIACLIA number must be 10 digits with a letter "D" in third position
    : value.matches('^[0-9]{2}D[0-9]{7}$')
    us-core-19errorOrganization.identifier:NAICNAIC must be 5 digits
    : value.matches('^[0-9]{5}$')

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Organization C 0..* Organization 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
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... Slices for identifier SΣC 0..* Identifier Identifies this organization across multiple systems
    Slice: Unordered, Open by value:$this
    .... identifier:All Slices Content/Rules for all slices
    ..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    ..... system SΣ 0..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    ..... value SΣ 0..1 string The value that is unique
    Example General: 123456
    .... identifier:NPI 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
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org/fhir/sid/us-npi
    .... identifier:CLIA Σ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
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: urn:oid:2.16.840.1.113883.4.7
    .... identifier:NAIC ΣC 0..* Identifier NAIC Code
    us-core-19: NAIC must be 5 digits

    Required Pattern: At least the following
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: urn:oid:2.16.840.1.113883.6.300
    ... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
    ... name SΣC 1..1 string Name used for the organization
    ... telecom SC 0..* ContactPoint A contact detail for the organization
    org-3: The telecom of an organization can never be of use 'home'
    .... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

    ... address SC 0..* Address An address for the organization
    org-2: An address of an organization can never be of use 'home'
    .... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.


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


    Example General: OK
    .... postalCode SΣ 0..1 string US Zip Codes
    Example General: 9132
    Example General: 74047
    .... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Organization.identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    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
    from this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    us-core-16errorOrganization.identifier:NPINPI must be 10 digits
    : value.matches('^[0-9]{10}$')
    us-core-17errorOrganization.identifier:NPINPI 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-18errorOrganization.identifier:CLIACLIA number must be 10 digits with a letter "D" in third position
    : value.matches('^[0-9]{2}D[0-9]{7}$')
    us-core-19errorOrganization.identifier:NAICNAIC must be 5 digits
    : value.matches('^[0-9]{5}$')

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Organization C 0..* Organization 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
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.

    Additional BindingsPurpose
    AllLanguages Max Binding
    ... 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 value:$this
    .... identifier:All Slices Content/Rules for all slices
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    ..... type Σ 0..1 CodeableConcept Description of identifier
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    ..... system SΣ 0..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    ..... value SΣ 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:NPI 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
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... use 0..1 code usual | official | temp | secondary | old (If known)
    ..... type 0..1 CodeableConcept Description of identifier
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org/fhir/sid/us-npi
    ..... value 0..1 string The value that is unique
    ..... period 0..1 Period Time period when id is/was valid for use
    ..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
    .... identifier:CLIA ΣC 0..* 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
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... use 0..1 code usual | official | temp | secondary | old (If known)
    ..... type 0..1 CodeableConcept Description of identifier
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: urn:oid:2.16.840.1.113883.4.7
    ..... value 0..1 string The value that is unique
    ..... period 0..1 Period Time period when id is/was valid for use
    ..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
    .... identifier:NAIC ΣC 0..* Identifier NAIC Code
    us-core-19: NAIC must be 5 digits

    Required Pattern: At least the following
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... use 0..1 code usual | official | temp | secondary | old (If known)
    ..... type 0..1 CodeableConcept Description of identifier
    ..... system 1..1 uri The namespace for the identifier value
    Fixed Value: urn:oid:2.16.840.1.113883.6.300
    ..... value 0..1 string The value that is unique
    ..... period 0..1 Period Time period when id is/was valid for use
    ..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
    ... active ?!SΣ 1..1 boolean Whether the organization's record is still in active use
    ... type Σ 0..* CodeableConcept Kind of organization
    Binding: OrganizationType (example): Used to categorize the organization.


    ... name SΣC 1..1 string Name used for the organization
    ... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
    ... telecom SC 0..* ContactPoint A contact detail for the organization
    org-3: The telecom of an organization can never be of use 'home'
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

    .... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
    .... period Σ 0..1 Period Time period when the contact point was/is in use
    ... address SC 0..* Address An address for the organization
    org-2: An address of an organization can never be of use 'home'
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.


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


    Example General: both
    .... text Σ 0..1 string Text representation of the address
    Example General: 137 Nowhere Street, Erewhon 9132
    .... line SΣ 0..4 string Street name, number, direction & P.O. Box etc.
    This repeating element order: The order in which lines should appear in an address label
    Example General: 137 Nowhere Street
    Example General: 49 MEADOW ST
    .... city SΣ 0..1 string Name of city, town etc.
    Example General: Erewhon
    Example General: EVERYTOWN
    .... district Σ 0..1 string District name (aka county)
    Example General: Madison
    .... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.


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

    .... name 0..1 HumanName A name associated with the contact
    .... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
    .... address 0..1 Address Visiting or postal addresses for the contact
    ... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Organization.languagepreferredCommonLanguages
    Additional Bindings Purpose
    AllLanguages Max Binding
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Organization.identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Organization.identifier.typeextensibleIdentifier Type Codes
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard
    Organization.typeexampleOrganizationType
    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
    from this IG
    Organization.contact.purposeextensibleContactEntityType
    http://hl7.org/fhir/ValueSet/contactentity-type
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    us-core-16errorOrganization.identifier:NPINPI must be 10 digits
    : value.matches('^[0-9]{10}$')
    us-core-17errorOrganization.identifier:NPINPI 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-18errorOrganization.identifier:CLIACLIA number must be 10 digits with a letter "D" in third position
    : value.matches('^[0-9]{2}D[0-9]{7}$')
    us-core-19errorOrganization.identifier:NAICNAIC must be 5 digits
    : value.matches('^[0-9]{5}$')

    This structure is derived from Organization

    Summary

    Mandatory: 2 elements
    Must-Support: 15 elements

    Slices

    This structure defines the following Slices:

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

    Maturity: 3

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:


    Quick Start


    Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

    • See the Scopes Format section for a description of the SMART scopes syntax.
    • See the Search Syntax section for a description of the US Core search syntax.
    • See the General Requirements section for additional rules and expectations when a Server requires status parameters.
    • See the General Guidance section for additional guidance on searching for multiple patients.

    US Core Scopes

    Servers providing access to organization data SHALL support these US Core SMART Scopes:

    Mandatory Search Parameters:

    The following search parameters and search parameter combinations SHALL be supported:

    1. SHALL support searching by organization name using the name search parameter:

      GET [base]/Organization?name=[string]

      Example:

      1. GET [base]/Organization?name=Health

      Implementation Notes: Fetches a bundle of all Organization resources that match the name (how to search by string)

    2. SHALL support searching organization based on text address using the address search parameter:

      GET [base]/Organization?address=[string]

      Example:

      1. GET [base]/Organization?address=Arbor

      Implementation Notes: Fetches a bundle of all Organization resources that match the address string (how to search by string)