National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: NDH Base Organization Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization Version: 1.0.0-ballot
Active as of 2023-07-30 Computable Name: NdhOrganization

Copyright/Legal: HL7 International

An organization is a formal or informal grouping of people or organizations with a common purpose, such as a company, institution, corporation, community group, or healthcare practice. Guidance: When the contact is a department name, rather than a human (e.g., patient help line), include a blank family and given name, and provide the department name in contact.name.text

Boundraries and Relationships

The Organization resource is commonly structured as a hierarchy of organization resources, where the part-of property is used to indicate the relationship between child and parent organizations. This hierarchy serves to convey the conceptual structure of the organization. Organization has following key attributes:

  1. A unique logical identifier that identifies the organization as an entity.
  2. The name of the organization as known to humans.
  3. Telecommunication identifiers that can be used to reach the organization.
  4. Information about any large organizations that the organization might be part of.
  5. One or more endpoints for electronic communication and data exchange.

Soliciting feedback for values in Organization.type valueset during the September Ballot

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rating 0..*(Complex)NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
... fundingSource 0..*(Complex)NDH Funding Source
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
... org-description 0..1stringOrganization Description
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
... digitalcertificate 0..*(Complex)Digital Certificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... insuranceplan 0..*Reference(NDH Base InsurancePlan Profile)Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... logo 0..1AttachmentNDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... identifier 0..*IdentifierIdentifies this organization across multiple systems
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... assigner 0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... identifier:TID 0..1IdentifierTax Identifier
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.fhir/sid/us-ssn
... active 1..1booleanWhether the organization's record is still in active use
Required Pattern: true
... type S1..*CodeableConceptKind of organization
Binding: Organization Type Value Set (extensible)
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type 0..1CodeableConceptOrganization Alias Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type
Binding: Organization Alias Type Value Sete (example)
.... org-alias-period 0..1PeriodOrganization Alias Period
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
... telecom
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... language-speak 0..*codeLanguage Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
... address
.... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
... partOf 0..1Reference(NDH Base Organization Profile)The organization of which this organization forms a part
... contact
.... telecom
..... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
... endpoint S0..*Reference(NDH Base Endpoint Profile)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organization.typeextensibleOrgTypeVS
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rating 0..*(Complex)NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
... fundingSource 0..*(Complex)NDH Funding Source
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
... org-description 0..1stringOrganization Description
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
... digitalcertificate 0..*(Complex)Digital Certificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... insuranceplan 0..*Reference(NDH Base InsurancePlan Profile)Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... logo 0..1AttachmentNDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General: 123456
..... assigner Σ0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
.... identifier:NPI SΣC0..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 ΣC0..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
.... identifier:TID SΣC0..1IdentifierTax Identifier

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.fhir/sid/us-ssn
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
Required Pattern: true
... type SΣ1..*CodeableConceptKind of organization
Binding: Organization Type Value Set (extensible)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type 0..1CodeableConceptOrganization Alias Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type
Binding: Organization Alias Type Value Sete (example)
.... org-alias-period 0..1PeriodOrganization Alias Period
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
... telecom SC0..*ContactPointA contact detail for the organization
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... language-speak 0..*codeLanguage Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

... address SC0..*AddressAn address for the organization
.... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..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Σ0..1stringName of city, town etc.
Example General: Erewhon
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... partOf Σ0..1Reference(NDH Base Organization Profile)The organization of which this organization forms a part
... endpoint S0..*Reference(NDH Base Endpoint Profile)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.identifier.userequiredIdentifierUse
Organization.typeextensibleOrgTypeVS
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rating 0..*(Complex)NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
... paymentaccepted 0..*CodeableConceptNDH Payment Accepted
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted
Binding: hl7VS-paymentMethodCode (required)
... fundingSource 0..*(Complex)NDH Funding Source
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
... org-description 0..1stringOrganization Description
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
... digitalcertificate 0..*(Complex)Digital Certificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... insuranceplan 0..*Reference(NDH Base InsurancePlan Profile)Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... logo 0..1AttachmentNDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣC0..*IdentifierIdentifies 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
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
.... identifier:NPI SΣC0..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 ΣC0..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)
.... identifier:TID SΣC0..1IdentifierTax Identifier

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-ssn
..... 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Σ1..1booleanWhether the organization's record is still in active use
Required Pattern: true
... type SΣ1..*CodeableConceptKind of organization
Binding: Organization Type Value Set (extensible)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type 0..1CodeableConceptOrganization Alias Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type
Binding: Organization Alias Type Value Sete (example)
.... org-alias-period 0..1PeriodOrganization Alias Period
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... telecom SC0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... language-speak 0..*codeLanguage Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address SC0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..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Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(NDH Base Organization Profile)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
..... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint S0..*Reference(NDH Base Endpoint Profile)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommonTags
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier.userequiredIdentifierUse
Organization.identifier.typeextensibleIdentifier Type Codes
Organization.typeextensibleOrgTypeVS
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Organization.contact.purposeextensibleContactEntityType
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredContactPointUse

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rating 0..*(Complex)NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
... fundingSource 0..*(Complex)NDH Funding Source
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
... org-description 0..1stringOrganization Description
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
... digitalcertificate 0..*(Complex)Digital Certificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... insuranceplan 0..*Reference(NDH Base InsurancePlan Profile)Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... logo 0..1AttachmentNDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... identifier 0..*IdentifierIdentifies this organization across multiple systems
.... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... assigner 0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
... identifier:TID 0..1IdentifierTax Identifier
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.fhir/sid/us-ssn
... active 1..1booleanWhether the organization's record is still in active use
Required Pattern: true
... type S1..*CodeableConceptKind of organization
Binding: Organization Type Value Set (extensible)
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type 0..1CodeableConceptOrganization Alias Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type
Binding: Organization Alias Type Value Sete (example)
.... org-alias-period 0..1PeriodOrganization Alias Period
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
... telecom
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... language-speak 0..*codeLanguage Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
... address
.... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
... partOf 0..1Reference(NDH Base Organization Profile)The organization of which this organization forms a part
... contact
.... telecom
..... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
... endpoint S0..*Reference(NDH Base Endpoint Profile)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organization.typeextensibleOrgTypeVS

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rating 0..*(Complex)NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
... fundingSource 0..*(Complex)NDH Funding Source
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
... org-description 0..1stringOrganization Description
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
... digitalcertificate 0..*(Complex)Digital Certificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... insuranceplan 0..*Reference(NDH Base InsurancePlan Profile)Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... logo 0..1AttachmentNDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General: 123456
..... assigner Σ0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
.... identifier:NPI SΣC0..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 ΣC0..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
.... identifier:TID SΣC0..1IdentifierTax Identifier

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.fhir/sid/us-ssn
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
Required Pattern: true
... type SΣ1..*CodeableConceptKind of organization
Binding: Organization Type Value Set (extensible)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type 0..1CodeableConceptOrganization Alias Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type
Binding: Organization Alias Type Value Sete (example)
.... org-alias-period 0..1PeriodOrganization Alias Period
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
... telecom SC0..*ContactPointA contact detail for the organization
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... language-speak 0..*codeLanguage Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

... address SC0..*AddressAn address for the organization
.... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..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Σ0..1stringName of city, town etc.
Example General: Erewhon
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... partOf Σ0..1Reference(NDH Base Organization Profile)The organization of which this organization forms a part
... endpoint S0..*Reference(NDH Base Endpoint Profile)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.identifier.userequiredIdentifierUse
Organization.typeextensibleOrgTypeVS
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*USCoreOrganizationProfileA grouping of people or organizations with a common purpose
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... rating 0..*(Complex)NDH Rating
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
... paymentaccepted 0..*CodeableConceptNDH Payment Accepted
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted
Binding: hl7VS-paymentMethodCode (required)
... fundingSource 0..*(Complex)NDH Funding Source
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
... org-description 0..1stringOrganization Description
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-description
... digitalcertificate 0..*(Complex)Digital Certificate
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-digitalcertificate
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification
... usage-restriction 0..*Reference(NDH Base Restriction) {c}Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
... insuranceplan 0..*Reference(NDH Base InsurancePlan Profile)Insurance plan(s) offered to the organization's employees
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-insuranceplan-reference
... verification-status 0..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... logo 0..1AttachmentNDH Logo
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣC0..*IdentifierIdentifies 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
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... identifier-status 0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(NDH Base Organization Profile)Organization that issued id (may be just text)
.... identifier:NPI SΣC0..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 ΣC0..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)
.... identifier:TID SΣC0..1IdentifierTax Identifier

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-ssn
..... 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Σ1..1booleanWhether the organization's record is still in active use
Required Pattern: true
... type SΣ1..*CodeableConceptKind of organization
Binding: Organization Type Value Set (extensible)
... name SΣC1..1stringName used for the organization
... alias S0..*stringA list of alternate names that the organization is known as, or was known as in the past
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... org-alias-type 0..1CodeableConceptOrganization Alias Type
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-type
Binding: Organization Alias Type Value Sete (example)
.... org-alias-period 0..1PeriodOrganization Alias Period
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-org-alias-period
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... telecom SC0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
.... language-speak 0..*codeLanguage Speak
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak
Binding: CommonLanguages (extensible)
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address SC0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... geolocation 0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..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Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(NDH Base Organization Profile)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contactpoint-availabletime 0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
..... via-intermediary 0..1Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)Via Intermediary
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
..... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint S0..*Reference(NDH Base Endpoint Profile)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommonTags
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier.userequiredIdentifierUse
Organization.identifier.typeextensibleIdentifier Type Codes
Organization.typeextensibleOrgTypeVS
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
Organization.contact.purposeextensibleContactEntityType
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredContactPointUse

This structure is derived from USCoreOrganizationProfile

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Search Parameters

Search Parameter defined by the NDH IG

None

Search Parameter defined by FHIR Search Parameter Registry and used by the NDH IG

Since there is no direct individual url for each Search Parameter defined by FHIR Serach Parameter Registry, we have provided the following links for you to access more information about them.

SearchParameter Name Type Example
active token GET [base]/Organization?active=true
address string GET [base]/Organization?address=123 Ravissant Dr
address-city string GET [base]/Organization?address-city=Coconut Creek
address-country string GET [base]/Organization?address-country=USA
address-postalcode string GET [base]/Organization?address-postcode=12345
address-state string GET [base]/Organization?address-state=FL
address-use token GET [base]/Organization?address-use=work
endpoint reference GET [base]/Organization?endpoint.connection-type=hl7-fhir-rest
identifier token GET [base]/Organization?identifier=12345
name string GET [base]/Organization?name=Florida Blue
partof reference GET [base]/Organization?partof.name=Florida Blue
type token GET [base]/Organization?type=gov  

_include Search Parameter

include Example
Organization:endpoint GET [base]/Organization?_include=Organization:endpoint
Organization:organization-identifier-assigner GET [base]/Organization?_include=Organization:organization-identifier-assigner
Organization:partof GET [base]/Organization?_include=Organization:partof

_revinclude Search Parameter

_revinclude
CareTeam:careteam-organization
Endpoint:organization
Endpoint:endpoint-identifier-assigner
HealthcareService:organization
HealthcareService:healthcareservice-new-patient-from-network
InsurancePlan:administered-by
InsurancePlan:owned-by
InsurancePlan:insuranceplan-coverage-network
InsurancePlan:insuranceplan-plan-network
InsurancePlan:insuranceplan-network
Location:organization
Location:location-new-patient-from-network
OrganizationAffiliation:network
OrganizationAffiliation:participating-organization
OrganizationAffiliation:primary-organization
Practitioner:practitioner-identifier-assigner
Practitioner:practitioner-qualification-issuer
PractitionerRole:organization
PractitionerRole:practitionerrole-network
PractitionerRole:practitionerrole-new-patient-from-network