FHIR Human Services Directory
1.0.0 - STU1
FHIR Human Services Directory
1.0.0 - STU1
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
| 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreOrganizationProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization | USCoreOrganizationProfile | |||
  id | 0..1 | id | Logical id of this artifact | |
 meta | 0..1 | Meta | Metadata about the resource | |
 id | 0..1 | string | Unique id for inter-element referencing | |
 lastUpdated | 1..1 | instant | When the resource version last changed | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 qualification | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/hsds/StructureDefinition/qualification | |
 extension:code | 0..1 | Extension | Extension | |
  value[x] | 0..1 | CodeableConcept | Value of extension Binding: Non-Individual Specialties (extensible) | |
| org-description | 0..1 | string | Organization Description URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/org-description | |
| identifier | 0..* | Identifier | Identifies this organization across multiple systems | |
| identifier:NPI | 0..1 | Identifier | National Provider Identifier (NPI) | |
| identifier:CLIA | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories | |
| identifier:IRS | 0..1 | Identifier | U.S. Tax ID (sometimes called Employer Identification Number (EIN) Required Pattern: At least the following | |
  system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:us:gov:irs | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
| type | 0..1 | CodeableConcept | Description of identifier | |
| system | 0..1 | uri | The namespace for the identifier value | |
| value | 0..1 | string | The value that is unique | |
| period | 0..1 | Period | Time period when id is/was valid for use | |
| assigner | ||||
| display | 0..1 | string | Text alternative for the resource Required Pattern: http://www.irs.gov | |
| active | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true | |
| type | 1..* | CodeableConcept | Kind of organization Binding: Organization Type VS (extensible) | |
| name | 1..1 | string | Name used for the organization | |
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
| telecom | 0..* | ContactPoint | A contact detail for the organization | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| contactpoint-availabletime | 0..0 | (Complex) | ||
| via-intermediary | 0..0 | Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) | ||
| system | 0..1 | code | phone | fax | email | pager | url | sms | other | |
| value | 0..1 | string | The actual contact point details | |
| use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
| rank | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |
| period | 0..1 | Period | Time period when the contact point was/is in use | |
| address | 0..0 | |||
| partOf | 0..0 | |||
| contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| purpose | 0..1 | CodeableConcept | The type of contact | |
| name | 0..1 | HumanName | A name associated with the contact | |
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| contactpoint-availabletime | 0..0 | (Complex) | ||
| via-intermediary | 0..0 | Reference(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..1 | code | phone | fax | email | pager | url | sms | other | |
| value | 0..1 | string | The actual contact point details | |
| use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| rank | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |
| period | 0..1 | Period | Time period when the contact point was/is in use | |
| address | 0..1 | Address | Visiting or postal addresses for the contact | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organization.extension:qualification.extension:code.value[x] | extensible | NonIndividualSpecialtiesVS |
| Organization.type | extensible | OrgTypeVS |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose |
 id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| qualification | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/hsds/StructureDefinition/qualification | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:identifier | 0..* | Extension | Extension | |
 extension | 0..0 | |||
| url | 1..1 | uri | "identifier" | |
| extension:code | 0..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "code" | |
| value[x] | 0..1 | CodeableConcept | Value of extension Binding: Non-Individual Specialties (extensible) | |
| extension:issuer | 0..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "issuer" | |
| extension:status | 1..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "status" | |
| extension:period | 0..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "period" | |
| extension:whereValid | 0..* | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "whereValid" | |
 value[x] | 1..1 | Value of extension Binding: USPS Two Letter Alphabetic Codes (required) | ||
| valueCodeableConcept | CodeableConcept | |||
 valueReference | Reference(HSDLocation) | |||
| url | 1..1 | uri | "http://hl7.org/fhir/us/hsds/StructureDefinition/qualification" | |
| org-description | 0..1 | string | Organization Description URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/org-description | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
 identifier:NPI | SΣC | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following |
 system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
| identifier:CLIA | ΣC | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |
 identifier:IRS | SΣC | 0..1 | Identifier | U.S. Tax ID (sometimes called Employer Identification Number (EIN) Required Pattern: At least the following |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:us:gov:irs | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true |
| type | Σ | 1..* | CodeableConcept | Kind of organization Binding: Organization Type VS (extensible) |
| name | SΣC | 1..1 | string | Name used for the organization |
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
| telecom | SC | 0..* | ContactPoint | A contact detail for the organization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | Σ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
| contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |
| name | 0..1 | HumanName | A name associated with the contact | |
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
| id | 0..1 | string | Unique 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 | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | Σ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work |
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
| address | 0..1 | Address | Visiting or postal addresses for the contact | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Organization.extension:qualification.extension:code.value[x] | extensible | NonIndividualSpecialtiesVS |
| Organization.extension:qualification.extension:whereValid.value[x] | required | UspsTwoLetterAlphabeticCodes |
| Organization.identifier:IRS.use | required | IdentifierUse |
| Organization.identifier:IRS.type | extensible | Identifier Type Codes |
| Organization.type | extensible | OrgTypeVS |
| Organization.telecom.system | required | ContactPointSystem |
| Organization.telecom.use | required | ContactPointUse |
| Organization.address.use | required | AddressUse |
| Organization.address.type | required | AddressType |
| Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes |
| Organization.contact.purpose | extensible | ContactEntityType |
| Organization.contact.telecom.system | required | ContactPointSystem |
| Organization.contact.telecom.use | required | Fixed Value: work |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags 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..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| qualification | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/hsds/StructureDefinition/qualification | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:identifier | 0..* | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "identifier" | |||||
| value[x] | 0..1 | Identifier | Value of extension | |||||
| extension:code | 0..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "code" | |||||
| value[x] | 0..1 | CodeableConcept | Value of extension Binding: Non-Individual Specialties (extensible) | |||||
| extension:issuer | 0..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "issuer" | |||||
| value[x] | 0..1 | Reference(HSDOrganization) | Value of extension | |||||
| extension:status | 1..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "status" | |||||
| value[x] | 0..1 | code | Value of extension Binding: Qualification Status VS (example) Fixed Value: active | |||||
| extension:period | 0..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "period" | |||||
| value[x] | 0..1 | Period | Value of extension | |||||
| extension:whereValid | 0..* | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "whereValid" | |||||
| value[x] | 1..1 | Value of extension Binding: USPS Two Letter Alphabetic Codes (required) | ||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueReference | Reference(HSDLocation) | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/hsds/StructureDefinition/qualification" | |||||
| org-description | 0..1 | string | Organization Description URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/org-description | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
| identifier:NPI | SΣC | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 0..1 | CodeableConcept | Description of identifier | |||||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
| value | 0..1 | string | The value that is unique | |||||
| period | 0..1 | Period | Time period when id is/was valid for use | |||||
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:CLIA | ΣC | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 0..1 | CodeableConcept | Description of identifier | |||||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |||||
| value | 0..1 | string | The value that is unique | |||||
| period | 0..1 | Period | Time period when id is/was valid for use | |||||
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:IRS | SΣC | 0..1 | Identifier | U.S. Tax ID (sometimes called Employer Identification Number (EIN) Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 0..1 | CodeableConcept | Description of identifier | |||||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:us:gov:irs | |||||
| value | 0..1 | string | The value that is unique | |||||
| period | 0..1 | Period | Time period when id is/was valid for use | |||||
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource Required Pattern: http://www.irs.gov | ||||
| active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true | ||||
| type | Σ | 1..* | CodeableConcept | Kind of organization Binding: Organization Type VS (extensible) | ||||
| name | SΣC | 1..1 | string | Name used for the organization | ||||
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| telecom | SC | 0..* | ContactPoint | A contact detail for the organization | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
| name | 0..1 | HumanName | A name associated with the contact | |||||
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional 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 | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Organization.meta.security | extensible | All Security Labels | ||||
| Organization.meta.tag | example | CommonTags | ||||
| Organization.language | preferred | CommonLanguages
| ||||
| Organization.extension:qualification.extension:code.value[x] | extensible | NonIndividualSpecialtiesVS | ||||
| Organization.extension:qualification.extension:status.value[x] | example | Fixed Value: active | ||||
| Organization.extension:qualification.extension:whereValid.value[x] | required | UspsTwoLetterAlphabeticCodes | ||||
| Organization.identifier:IRS.use | required | IdentifierUse | ||||
| Organization.identifier:IRS.type | extensible | Identifier Type Codes | ||||
| Organization.identifier:IRS.assigner.type | extensible | ResourceType | ||||
| Organization.type | extensible | OrgTypeVS | ||||
| Organization.telecom.system | required | ContactPointSystem | ||||
| Organization.telecom.use | required | ContactPointUse | ||||
| Organization.address.use | required | AddressUse | ||||
| Organization.address.type | required | AddressType | ||||
| Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes | ||||
| Organization.contact.purpose | extensible | ContactEntityType | ||||
| Organization.contact.telecom.system | required | ContactPointSystem | ||||
| Organization.contact.telecom.use | required | Fixed Value: work |
This structure is derived from USCoreOrganizationProfile
Summary
Mandatory: 1 element (1 nested mandatory element)
Fixed Value: 1 element
Prohibited: 6 elements
Extensions
This structure refers to these extensions:
Maturity: 2
Differential View
This structure is derived from USCoreOrganizationProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | USCoreOrganizationProfile | |||
| id | 0..1 | id | Logical id of this artifact | |
| meta | 0..1 | Meta | Metadata about the resource | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| lastUpdated | 1..1 | instant | When the resource version last changed | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| qualification | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/hsds/StructureDefinition/qualification | |
| extension:code | 0..1 | Extension | Extension | |
| value[x] | 0..1 | CodeableConcept | Value of extension Binding: Non-Individual Specialties (extensible) | |
| org-description | 0..1 | string | Organization Description URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/org-description | |
| identifier | 0..* | Identifier | Identifies this organization across multiple systems | |
| identifier:NPI | 0..1 | Identifier | National Provider Identifier (NPI) | |
| identifier:CLIA | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories | |
| identifier:IRS | 0..1 | Identifier | U.S. Tax ID (sometimes called Employer Identification Number (EIN) Required Pattern: At least the following | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:us:gov:irs | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
| type | 0..1 | CodeableConcept | Description of identifier | |
| system | 0..1 | uri | The namespace for the identifier value | |
| value | 0..1 | string | The value that is unique | |
| period | 0..1 | Period | Time period when id is/was valid for use | |
| assigner | ||||
| display | 0..1 | string | Text alternative for the resource Required Pattern: http://www.irs.gov | |
| active | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true | |
| type | 1..* | CodeableConcept | Kind of organization Binding: Organization Type VS (extensible) | |
| name | 1..1 | string | Name used for the organization | |
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
| telecom | 0..* | ContactPoint | A contact detail for the organization | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| contactpoint-availabletime | 0..0 | (Complex) | ||
| via-intermediary | 0..0 | Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) | ||
| system | 0..1 | code | phone | fax | email | pager | url | sms | other | |
| value | 0..1 | string | The actual contact point details | |
| use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point | |
| rank | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |
| period | 0..1 | Period | Time period when the contact point was/is in use | |
| address | 0..0 | |||
| partOf | 0..0 | |||
| contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| purpose | 0..1 | CodeableConcept | The type of contact | |
| name | 0..1 | HumanName | A name associated with the contact | |
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| contactpoint-availabletime | 0..0 | (Complex) | ||
| via-intermediary | 0..0 | Reference(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..1 | code | phone | fax | email | pager | url | sms | other | |
| value | 0..1 | string | The actual contact point details | |
| use | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work | |
| rank | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |
| period | 0..1 | Period | Time period when the contact point was/is in use | |
| address | 0..1 | Address | Visiting or postal addresses for the contact | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organization.extension:qualification.extension:code.value[x] | extensible | NonIndividualSpecialtiesVS |
| Organization.type | extensible | OrgTypeVS |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| qualification | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/hsds/StructureDefinition/qualification | |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:identifier | 0..* | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "identifier" | |
| extension:code | 0..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "code" | |
| value[x] | 0..1 | CodeableConcept | Value of extension Binding: Non-Individual Specialties (extensible) | |
| extension:issuer | 0..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "issuer" | |
| extension:status | 1..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "status" | |
| extension:period | 0..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "period" | |
| extension:whereValid | 0..* | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "whereValid" | |
| value[x] | 1..1 | Value of extension Binding: USPS Two Letter Alphabetic Codes (required) | ||
| valueCodeableConcept | CodeableConcept | |||
| valueReference | Reference(HSDLocation) | |||
| url | 1..1 | uri | "http://hl7.org/fhir/us/hsds/StructureDefinition/qualification" | |
| org-description | 0..1 | string | Organization Description URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/org-description | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this |
| identifier:NPI | SΣC | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
| identifier:CLIA | ΣC | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |
| identifier:IRS | SΣC | 0..1 | Identifier | U.S. Tax ID (sometimes called Employer Identification Number (EIN) Required Pattern: At least the following |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:us:gov:irs | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true |
| type | Σ | 1..* | CodeableConcept | Kind of organization Binding: Organization Type VS (extensible) |
| name | SΣC | 1..1 | string | Name used for the organization |
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
| telecom | SC | 0..* | ContactPoint | A contact detail for the organization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | Σ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
| contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |
| name | 0..1 | HumanName | A name associated with the contact | |
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
| id | 0..1 | string | Unique 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 | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | Σ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work |
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
| address | 0..1 | Address | Visiting or postal addresses for the contact | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Organization.extension:qualification.extension:code.value[x] | extensible | NonIndividualSpecialtiesVS |
| Organization.extension:qualification.extension:whereValid.value[x] | required | UspsTwoLetterAlphabeticCodes |
| Organization.identifier:IRS.use | required | IdentifierUse |
| Organization.identifier:IRS.type | extensible | Identifier Type Codes |
| Organization.type | extensible | OrgTypeVS |
| Organization.telecom.system | required | ContactPointSystem |
| Organization.telecom.use | required | ContactPointUse |
| Organization.address.use | required | AddressUse |
| Organization.address.type | required | AddressType |
| Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes |
| Organization.contact.purpose | extensible | ContactEntityType |
| Organization.contact.telecom.system | required | ContactPointSystem |
| Organization.contact.telecom.use | required | Fixed Value: work |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Organization | C | 0..* | USCoreOrganizationProfile | A grouping of people or organizations with a common purpose | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags 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..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| qualification | 0..* | (Complex) | Qualification URL: http://hl7.org/fhir/us/hsds/StructureDefinition/qualification | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:identifier | 0..* | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "identifier" | |||||
| value[x] | 0..1 | Identifier | Value of extension | |||||
| extension:code | 0..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "code" | |||||
| value[x] | 0..1 | CodeableConcept | Value of extension Binding: Non-Individual Specialties (extensible) | |||||
| extension:issuer | 0..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "issuer" | |||||
| value[x] | 0..1 | Reference(HSDOrganization) | Value of extension | |||||
| extension:status | 1..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "status" | |||||
| value[x] | 0..1 | code | Value of extension Binding: Qualification Status VS (example) Fixed Value: active | |||||
| extension:period | 0..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "period" | |||||
| value[x] | 0..1 | Period | Value of extension | |||||
| extension:whereValid | 0..* | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "whereValid" | |||||
| value[x] | 1..1 | Value of extension Binding: USPS Two Letter Alphabetic Codes (required) | ||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueReference | Reference(HSDLocation) | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/hsds/StructureDefinition/qualification" | |||||
| org-description | 0..1 | string | Organization Description URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/org-description | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by pattern:$this | ||||
| identifier:NPI | SΣC | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 0..1 | CodeableConcept | Description of identifier | |||||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
| value | 0..1 | string | The value that is unique | |||||
| period | 0..1 | Period | Time period when id is/was valid for use | |||||
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:CLIA | ΣC | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 0..1 | CodeableConcept | Description of identifier | |||||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |||||
| value | 0..1 | string | The value that is unique | |||||
| period | 0..1 | Period | Time period when id is/was valid for use | |||||
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| identifier:IRS | SΣC | 0..1 | Identifier | U.S. Tax ID (sometimes called Employer Identification Number (EIN) Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 0..1 | CodeableConcept | Description of identifier | |||||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:us:gov:irs | |||||
| value | 0..1 | string | The value that is unique | |||||
| period | 0..1 | Period | Time period when id is/was valid for use | |||||
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource Required Pattern: http://www.irs.gov | ||||
| active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use Required Pattern: true | ||||
| type | Σ | 1..* | CodeableConcept | Kind of organization Binding: Organization Type VS (extensible) | ||||
| name | SΣC | 1..1 | string | Name used for the organization | ||||
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| telecom | SC | 0..* | ContactPoint | A contact detail for the organization | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
| name | 0..1 | HumanName | A name associated with the contact | |||||
| telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional 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 | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address | 0..1 | Address | Visiting or postal addresses for the contact | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Organization.meta.security | extensible | All Security Labels | ||||
| Organization.meta.tag | example | CommonTags | ||||
| Organization.language | preferred | CommonLanguages
| ||||
| Organization.extension:qualification.extension:code.value[x] | extensible | NonIndividualSpecialtiesVS | ||||
| Organization.extension:qualification.extension:status.value[x] | example | Fixed Value: active | ||||
| Organization.extension:qualification.extension:whereValid.value[x] | required | UspsTwoLetterAlphabeticCodes | ||||
| Organization.identifier:IRS.use | required | IdentifierUse | ||||
| Organization.identifier:IRS.type | extensible | Identifier Type Codes | ||||
| Organization.identifier:IRS.assigner.type | extensible | ResourceType | ||||
| Organization.type | extensible | OrgTypeVS | ||||
| Organization.telecom.system | required | ContactPointSystem | ||||
| Organization.telecom.use | required | ContactPointUse | ||||
| Organization.address.use | required | AddressUse | ||||
| Organization.address.type | required | AddressType | ||||
| Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes | ||||
| Organization.contact.purpose | extensible | ContactEntityType | ||||
| Organization.contact.telecom.system | required | ContactPointSystem | ||||
| Organization.contact.telecom.use | required | Fixed Value: work |
This structure is derived from USCoreOrganizationProfile
Summary
Mandatory: 1 element (1 nested mandatory element)
Fixed Value: 1 element
Prohibited: 6 elements
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 Human and Social Services Work Group. Package hl7.fhir.us.hsds#1.0.0 based on FHIR 4.0.1. Generated 2023-10-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change