FHIR Human Services Directory
1.0.0 - STU1 United States of America flag

FHIR Human Services Directory, published by HL7 Human and Social Services Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/FHIR-IG-Human-Services-Directory/ and changes regularly. See the Directory of published versions

Resource Profile: HSDOrganization

Official URL: http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Organization Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: HSDOrganization

The HSDOrganization resource is a formal or informal grouping of people or organizations set up to assist people in coping with issues related to various social issues, including but not limited to: adequate housing, substance abuse, domestic conflict, mental health and/or personal/familial problems. 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.

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 USCoreOrganizationProfile
... id 0..1idLogical id of this artifact
... meta 0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... lastUpdated 1..1instantWhen the resource version last changed
... text 0..1NarrativeText summary of the resource, for human interpretation
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/hsds/StructureDefinition/qualification
.... extension:code 0..1ExtensionExtension
..... value[x] 0..1CodeableConceptValue of extension
Binding: Non-Individual Specialties (extensible)
... org-description 0..1stringOrganization Description
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/org-description
... identifier 0..*IdentifierIdentifies this organization across multiple systems
... identifier:NPI 0..1IdentifierNational Provider Identifier (NPI)
... identifier:CLIA 0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories
... identifier:IRS 0..1IdentifierU.S. Tax ID (sometimes called Employer Identification Number (EIN)
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: urn:us:gov:irs
.... id 0..1stringUnique id for inter-element referencing
.... use 0..1codeusual | official | temp | secondary | old (If known)
.... type 0..1CodeableConceptDescription of identifier
.... system 0..1uriThe namespace for the identifier value
.... value 0..1stringThe value that is unique
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner
..... display 0..1stringText alternative for the resource
Required Pattern: http://www.irs.gov
... active 1..1booleanWhether the organization's record is still in active use
Required Pattern: true
... type 1..*CodeableConceptKind of organization
Binding: Organization Type VS (extensible)
... name 1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom 0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... contactpoint-availabletime 0..0(Complex)
.... via-intermediary 0..0Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)
.... system 0..1codephone | fax | email | pager | url | sms | other
.... value 0..1stringThe actual contact point details
.... use 0..1codehome | work | temp | old | mobile - purpose of this 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..0
... partOf 0..0
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... purpose 0..1CodeableConceptThe type of contact
.... 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
..... contactpoint-availabletime 0..0(Complex)
..... via-intermediary 0..0Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)
..... org-contactinfo 0..*(Complex)Organization's Additional Contacts details
URL: http://hl7.org/fhir/us/hsds/StructureDefinition/org-contactinfo
..... system 0..1codephone | fax | email | pager | url | sms | other
..... value 0..1stringThe actual contact point details
..... use 0..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
..... 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 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organization.extension:qualification.extension:code.value[x]extensibleNonIndividualSpecialtiesVS
Organization.typeextensibleOrgTypeVS
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
.... lastUpdated Σ1..1instantWhen the resource version last changed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/hsds/StructureDefinition/qualification
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:identifier 0..*ExtensionExtension
..... extension 0..0
..... url 1..1uri"identifier"
.... extension:code 0..1ExtensionExtension
..... extension 0..0
..... url 1..1uri"code"
..... value[x] 0..1CodeableConceptValue of extension
Binding: Non-Individual Specialties (extensible)
.... extension:issuer 0..1ExtensionExtension
..... extension 0..0
..... url 1..1uri"issuer"
.... extension:status 1..1ExtensionExtension
..... extension 0..0
..... url 1..1uri"status"
.... extension:period 0..1ExtensionExtension
..... extension 0..0
..... url 1..1uri"period"
.... extension:whereValid 0..*ExtensionExtension
..... extension 0..0
..... url 1..1uri"whereValid"
..... value[x] 1..1Value of extension
Binding: USPS Two Letter Alphabetic Codes (required)
...... valueCodeableConceptCodeableConcept
...... valueReferenceReference(HSDLocation)
.... url 1..1uri"http://hl7.org/fhir/us/hsds/StructureDefinition/qualification"
... org-description 0..1stringOrganization Description
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/org-description
... 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: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:IRS SΣC0..1IdentifierU.S. Tax ID (sometimes called Employer Identification Number (EIN)

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:us:gov:irs
..... id 0..1stringUnique id for inter-element referencing
..... 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
Required Pattern: true
... type Σ1..*CodeableConceptKind of organization
Binding: Organization Type VS (extensible)
... name SΣC1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SC0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... 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
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... 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
..... org-contactinfo 0..*(Complex)Organization's Additional Contacts details
URL: http://hl7.org/fhir/us/hsds/StructureDefinition/org-contactinfo
..... 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.


Fixed Value: work
..... 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 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.extension:qualification.extension:code.value[x]extensibleNonIndividualSpecialtiesVS
Organization.extension:qualification.extension:whereValid.value[x]requiredUspsTwoLetterAlphabeticCodes
Organization.identifier:IRS.userequiredIdentifierUse
Organization.identifier:IRS.typeextensibleIdentifier Type Codes
Organization.typeextensibleOrgTypeVS
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
Organization.contact.purposeextensibleContactEntityType
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredFixed Value: work
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
... 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
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/hsds/StructureDefinition/qualification
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:identifier 0..*ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"identifier"
..... value[x] 0..1IdentifierValue of extension
.... extension:code 0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"code"
..... value[x] 0..1CodeableConceptValue of extension
Binding: Non-Individual Specialties (extensible)
.... extension:issuer 0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"issuer"
..... value[x] 0..1Reference(HSDOrganization)Value of extension
.... extension:status 1..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"status"
..... value[x] 0..1codeValue of extension
Binding: Qualification Status VS (example)
Fixed Value: active
.... extension:period 0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"period"
..... value[x] 0..1PeriodValue of extension
.... extension:whereValid 0..*ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"whereValid"
..... value[x] 1..1Value of extension
Binding: USPS Two Letter Alphabetic Codes (required)
...... valueCodeableConceptCodeableConcept
...... valueReferenceReference(HSDLocation)
.... url 1..1uri"http://hl7.org/fhir/us/hsds/StructureDefinition/qualification"
... org-description 0..1stringOrganization Description
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/org-description
... 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: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:IRS SΣC0..1IdentifierU.S. Tax ID (sometimes called Employer Identification Number (EIN)

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:us:gov:irs
..... 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)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ0..1stringText alternative for the resource
Required Pattern: http://www.irs.gov
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
Required Pattern: true
... type Σ1..*CodeableConceptKind of organization
Binding: Organization Type VS (extensible)
... name SΣC1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... 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
.... 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
... 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
..... org-contactinfo 0..*(Complex)Organization's Additional Contacts details
URL: http://hl7.org/fhir/us/hsds/StructureDefinition/org-contactinfo
..... 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.


Fixed Value: work
..... 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 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommonTags
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.extension:qualification.extension:code.value[x]extensibleNonIndividualSpecialtiesVS
Organization.extension:qualification.extension:status.value[x]exampleFixed Value: active
Organization.extension:qualification.extension:whereValid.value[x]requiredUspsTwoLetterAlphabeticCodes
Organization.identifier:IRS.userequiredIdentifierUse
Organization.identifier:IRS.typeextensibleIdentifier Type Codes
Organization.identifier:IRS.assigner.typeextensibleResourceType
Organization.typeextensibleOrgTypeVS
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
Organization.contact.purposeextensibleContactEntityType
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredFixed Value: work

Differential View

This structure is derived from USCoreOrganizationProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization USCoreOrganizationProfile
... id 0..1idLogical id of this artifact
... meta 0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... lastUpdated 1..1instantWhen the resource version last changed
... text 0..1NarrativeText summary of the resource, for human interpretation
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/hsds/StructureDefinition/qualification
.... extension:code 0..1ExtensionExtension
..... value[x] 0..1CodeableConceptValue of extension
Binding: Non-Individual Specialties (extensible)
... org-description 0..1stringOrganization Description
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/org-description
... identifier 0..*IdentifierIdentifies this organization across multiple systems
... identifier:NPI 0..1IdentifierNational Provider Identifier (NPI)
... identifier:CLIA 0..1IdentifierClinical Laboratory Improvement Amendments (CLIA) Number for laboratories
... identifier:IRS 0..1IdentifierU.S. Tax ID (sometimes called Employer Identification Number (EIN)
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: urn:us:gov:irs
.... id 0..1stringUnique id for inter-element referencing
.... use 0..1codeusual | official | temp | secondary | old (If known)
.... type 0..1CodeableConceptDescription of identifier
.... system 0..1uriThe namespace for the identifier value
.... value 0..1stringThe value that is unique
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner
..... display 0..1stringText alternative for the resource
Required Pattern: http://www.irs.gov
... active 1..1booleanWhether the organization's record is still in active use
Required Pattern: true
... type 1..*CodeableConceptKind of organization
Binding: Organization Type VS (extensible)
... name 1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom 0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... contactpoint-availabletime 0..0(Complex)
.... via-intermediary 0..0Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)
.... system 0..1codephone | fax | email | pager | url | sms | other
.... value 0..1stringThe actual contact point details
.... use 0..1codehome | work | temp | old | mobile - purpose of this 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..0
... partOf 0..0
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... purpose 0..1CodeableConceptThe type of contact
.... 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
..... contactpoint-availabletime 0..0(Complex)
..... via-intermediary 0..0Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)
..... org-contactinfo 0..*(Complex)Organization's Additional Contacts details
URL: http://hl7.org/fhir/us/hsds/StructureDefinition/org-contactinfo
..... system 0..1codephone | fax | email | pager | url | sms | other
..... value 0..1stringThe actual contact point details
..... use 0..1codehome | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
..... 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 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organization.extension:qualification.extension:code.value[x]extensibleNonIndividualSpecialtiesVS
Organization.typeextensibleOrgTypeVS

Key Elements 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
.... lastUpdated Σ1..1instantWhen the resource version last changed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/hsds/StructureDefinition/qualification
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:identifier 0..*ExtensionExtension
..... extension 0..0
..... url 1..1uri"identifier"
.... extension:code 0..1ExtensionExtension
..... extension 0..0
..... url 1..1uri"code"
..... value[x] 0..1CodeableConceptValue of extension
Binding: Non-Individual Specialties (extensible)
.... extension:issuer 0..1ExtensionExtension
..... extension 0..0
..... url 1..1uri"issuer"
.... extension:status 1..1ExtensionExtension
..... extension 0..0
..... url 1..1uri"status"
.... extension:period 0..1ExtensionExtension
..... extension 0..0
..... url 1..1uri"period"
.... extension:whereValid 0..*ExtensionExtension
..... extension 0..0
..... url 1..1uri"whereValid"
..... value[x] 1..1Value of extension
Binding: USPS Two Letter Alphabetic Codes (required)
...... valueCodeableConceptCodeableConcept
...... valueReferenceReference(HSDLocation)
.... url 1..1uri"http://hl7.org/fhir/us/hsds/StructureDefinition/qualification"
... org-description 0..1stringOrganization Description
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/org-description
... 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: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:IRS SΣC0..1IdentifierU.S. Tax ID (sometimes called Employer Identification Number (EIN)

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: urn:us:gov:irs
..... id 0..1stringUnique id for inter-element referencing
..... 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
Required Pattern: true
... type Σ1..*CodeableConceptKind of organization
Binding: Organization Type VS (extensible)
... name SΣC1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SC0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... 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
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... 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
..... org-contactinfo 0..*(Complex)Organization's Additional Contacts details
URL: http://hl7.org/fhir/us/hsds/StructureDefinition/org-contactinfo
..... 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.


Fixed Value: work
..... 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 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.extension:qualification.extension:code.value[x]extensibleNonIndividualSpecialtiesVS
Organization.extension:qualification.extension:whereValid.value[x]requiredUspsTwoLetterAlphabeticCodes
Organization.identifier:IRS.userequiredIdentifierUse
Organization.identifier:IRS.typeextensibleIdentifier Type Codes
Organization.typeextensibleOrgTypeVS
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.address.stateextensibleUspsTwoLetterAlphabeticCodes
Organization.contact.purposeextensibleContactEntityType
Organization.contact.telecom.systemrequiredContactPointSystem
Organization.contact.telecom.userequiredFixed Value: work

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
... 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
... qualification 0..*(Complex)Qualification
URL: http://hl7.org/fhir/us/hsds/StructureDefinition/qualification
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:identifier 0..*ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"identifier"
..... value[x] 0..1IdentifierValue of extension
.... extension:code 0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"code"
..... value[x] 0..1CodeableConceptValue of extension
Binding: Non-Individual Specialties (extensible)
.... extension:issuer 0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"issuer"
..... value[x] 0..1Reference(HSDOrganization)Value of extension
.... extension:status 1..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"status"
..... value[x] 0..1codeValue of extension
Binding: Qualification Status VS (example)
Fixed Value: active
.... extension:period 0..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"period"
..... value[x] 0..1PeriodValue of extension
.... extension:whereValid 0..*ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"whereValid"
..... value[x] 1..1Value of extension
Binding: USPS Two Letter Alphabetic Codes (required)
...... valueCodeableConceptCodeableConcept
...... valueReferenceReference(HSDLocation)
.... url 1..1uri"http://hl7.org/fhir/us/hsds/StructureDefinition/qualification"
... org-description 0..1stringOrganization Description
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/org-description
... 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: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:IRS SΣC0..1IdentifierU.S. Tax ID (sometimes called Employer Identification Number (EIN)

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:us:gov:irs
..... 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)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... 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 Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ0..1stringText alternative for the resource
Required Pattern: http://www.irs.gov
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
Required Pattern: true
... type Σ1..*CodeableConceptKind of organization
Binding: Organization Type VS (extensible)
... name SΣC1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... 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
.... 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
... 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
..... org-contactinfo 0..*(Complex)Organization's Additional Contacts details
URL: http://hl7.org/fhir/us/hsds/StructureDefinition/org-contactinfo
..... 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.


Fixed Value: work
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.