HL7 FHIR® US Core Implementation Guide STU3 Release 3.1.0

This page is part of the US Core (v3.1.0: STU3) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 8.0.0. For a full list of available versions, see the Directory of published versions. Page versions: R8 R7 R6 R5 R4 R3

StructureDefinition-us-core-organization

This profile sets minimum expectations for the Organization resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the US Core-Organization profile:

  • Query by organization name or NPI

Mandatory and Must Support Data Elements

The following data-elements are mandatory (i.e data MUST be present) 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 Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Organization must have:

  1. A status of the organization
  2. A name

Each Organization must support:

  1. An identifier
    • National Provider Identifier (NPI) for organizations
    • Clinical Laboratory Improvement Amendments (CLIA) for laboratories.
  2. A list of contact information

Profile specific implementation guidance:

  • none

Examples

Organization-acme-lab

Organization-with-EndPoint

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization

Published on Sat Aug 31 00:00:00 AEST 2019 as active by the HL7 US Realm Steering Committee.

This profile builds on Organization

Organization

Summary of the Mandatory Requirements

  1. A boolean in Organization.active
  2. A string in Organization.name

Summary of the Must Support Requirements

  1. One or more Identifiers in Organization.identifier
  2. A Identifier in Organization.identifier
    • which should have a fixed Organization.identifier.system = http://example.org/fhir/sid/us-npi
    • which should have a string value in Organization.identifier.value
  3. A Identifier in Organization.identifier
    • which should have a fixed Organization.identifier.system = urn:oid:2.16.840.1.113883.4.7
    • which should have a string value in Organization.identifier.value
  4. One or more ContactPoints in Organization.telecom with the following constraints: The telecom of an organization can never be of use 'home'
  5. One or more Addresses in Organization.address with the following constraints: An address of an organization can never be of use 'home'
    • which should have one or more string values in Organization.address.line
    • which should have a string value in Organization.address.city
    • which should have a string value in Organization.address.state with an extensible binding to USPS Two Letter Alphabetic Codes
    • which should have a string value in Organization.address.postalCode
    • which should have a string value in Organization.address.country

Summary of Constraints

  1. The organization SHALL at least have a name or an identifier, and possibly more than one
  2. The telecom of an organization can never be of use 'home'
  3. An address of an organization can never be of use 'home'
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*
... identifier S0..*(Slice Definition)Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... system S0..1uri
..... value S0..1string
.... identifier:NPI S0..1IdentifierNational Provider Identifier (NPI)
Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... identifier:CLIA S0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
... active S1..1boolean
... name S1..1string
... telecom S0..*ContactPoint
... address S0..*Address
.... line S0..4string
.... city S0..1string
.... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode S0..1stringUS Zip Codes
.... country S0..1string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system SΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:NPI SΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CLIA SΣI0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣI1..1booleanWhether the organization's record is still in active use
... type ΣI0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name SΣI1..1stringName used for the organization
... alias I0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI0..*ContactPointA contact detail for the organization
... address SI0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
.... type ΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text ΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣI0..4stringStreet 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ΣI0..1stringName of city, town etc.
Example General: Erewhon
.... district ΣI0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣI0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣI0..1stringUS Zip Codes
Example General: 9132
.... country SΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period ΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}
... partOf ΣI0..1Reference(Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose I0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name I0..1HumanNameA name associated with the contact
.... telecom I0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address I0..1AddressVisiting or postal addresses for the contact
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Organization

Summary of the Mandatory Requirements

  1. A boolean in Organization.active
  2. A string in Organization.name

Summary of the Must Support Requirements

  1. One or more Identifiers in Organization.identifier
  2. A Identifier in Organization.identifier
    • which should have a fixed Organization.identifier.system = http://example.org/fhir/sid/us-npi
    • which should have a string value in Organization.identifier.value
  3. A Identifier in Organization.identifier
    • which should have a fixed Organization.identifier.system = urn:oid:2.16.840.1.113883.4.7
    • which should have a string value in Organization.identifier.value
  4. One or more ContactPoints in Organization.telecom with the following constraints: The telecom of an organization can never be of use 'home'
  5. One or more Addresses in Organization.address with the following constraints: An address of an organization can never be of use 'home'
    • which should have one or more string values in Organization.address.line
    • which should have a string value in Organization.address.city
    • which should have a string value in Organization.address.state with an extensible binding to USPS Two Letter Alphabetic Codes
    • which should have a string value in Organization.address.postalCode
    • which should have a string value in Organization.address.country

Summary of Constraints

  1. The organization SHALL at least have a name or an identifier, and possibly more than one
  2. The telecom of an organization can never be of use 'home'
  3. An address of an organization can never be of use 'home'

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*
... identifier S0..*(Slice Definition)Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... system S0..1uri
..... value S0..1string
.... identifier:NPI S0..1IdentifierNational Provider Identifier (NPI)
Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... identifier:CLIA S0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories
Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
... active S1..1boolean
... name S1..1string
... telecom S0..*ContactPoint
... address S0..*Address
.... line S0..4string
.... city S0..1string
.... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode S0..1stringUS Zip Codes
.... country S0..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system SΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣI0..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:NPI SΣI0..1IdentifierNational Provider Identifier (NPI)

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CLIA SΣI0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.7
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣI1..1booleanWhether the organization's record is still in active use
... type ΣI0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name SΣI1..1stringName used for the organization
... alias I0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI0..*ContactPointA contact detail for the organization
... address SI0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General: home
.... type ΣI0..1codepostal | physical | both
Binding: AddressType (required)
Example General: both
.... text ΣI0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣI0..4stringStreet 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ΣI0..1stringName of city, town etc.
Example General: Erewhon
.... district ΣI0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣI0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣI0..1stringUS Zip Codes
Example General: 9132
.... country SΣI0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period ΣI0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"}
... partOf ΣI0..1Reference(Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose I0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name I0..1HumanNameA name associated with the contact
.... telecom I0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address I0..1AddressVisiting or postal addresses for the contact
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

  • See the General Guidance 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.

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]/Location?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]/Location?address=Arbor

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