This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndhEx-OrganizationAffiliation | Version: 1.0.0-ballot | |||
Active as of 2023-07-30 | Computable Name: NdhExOrganizationAffiliation |
The OrganizationAffiliation resource describes relationships between two or more organizations, including the services one organization provides another, the location(s) where they provide services, the availability of those services, electronic endpoints, and other relevant information.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NdhOrganizationAffiliation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OrganizationAffiliation | 0..* | NdhOrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | |
meta | ||||
profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
extension | 1..* | Extension | Extension | |
extension:qualification | S | 0..* | Qualification | NDH Qualification |
extension:verification-status | S | 1..1 | VerificationStatus | NDH Verification Status |
identifier | ||||
extension | 1..* | Extension | Extension | |
extension:identifier-status | S | 1..1 | IdentifierStatus | NDH Identifier Status |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
type | S | 0..1 | CodeableConcept | Description of identifier |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 0..1 | string | The value that is unique |
assigner | S | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
active | S | 1..1 | boolean | Whether this organization affiliation record is in active use |
organization | 0..1 | Reference(NDH Exchange Organization Profile) | Organization where the role is available | |
participatingOrganization | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that provides/performs the role (e.g. providing services or is a member of) | |
network | S | 0..* | Reference(NDH Exchange Network Profile) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) |
code | S | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays |
specialty | S | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role |
location | 0..* | Reference(NDH Exchange Location Profile) | The location(s) at which the role occurs | |
healthcareService | S | 0..* | Reference(NDH Exchange HealthcareService Profile) | Healthcare services provided through the role |
telecom | S | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation |
extension:contactpoint-availabletime | S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
extension:via-intermediary | S | 0..1 | ViaIntermediary | NDH Via Intermediary |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
value | S | 0..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
endpoint | 0..* | Reference(NDH Exchange Endpoint Profile) | Technical endpoints providing access to services operated for this role | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OrganizationAffiliation | C | 0..* | NdhOrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
qualification | S | 0..* | (Complex) | NDH Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification |
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) |
logo | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Business identifiers that are specific to this role |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-status | S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) |
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
assigner | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
active | SΣ | 1..1 | boolean | Whether this organization affiliation record is in active use Required Pattern: true |
period | SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization |
organization | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization where the role is available |
participatingOrganization | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that provides/performs the role (e.g. providing services or is a member of) |
network | SΣ | 0..* | Reference(NDH Exchange Network Profile) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) |
code | SΣ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible) |
specialty | SΣ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: Specialties Value Set (extensible) |
location | SΣ | 0..* | Reference(NDH Exchange Location Profile) | The location(s) at which the role occurs |
healthcareService | S | 0..* | Reference(NDH Exchange HealthcareService Profile) | Healthcare services provided through the role |
telecom | SΣ | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation |
contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | SΣ | 0..1 | string | The actual contact point details |
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
endpoint | S | 0..* | Reference(NDH Exchange Endpoint Profile) | Technical endpoints providing access to services operated for this role |
Documentation for this format |
Path | Conformance | ValueSet |
OrganizationAffiliation.identifier.use | required | IdentifierUse |
OrganizationAffiliation.identifier.type | extensible | Identifier Type Codes |
OrganizationAffiliation.code | extensible | OrganizationAffiliationRoleVS |
OrganizationAffiliation.specialty | extensible | SpecialtiesVS |
OrganizationAffiliation.telecom.system | required | ContactPointSystem |
OrganizationAffiliation.telecom.use | required | ContactPointUse |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
OrganizationAffiliation | C | 0..* | NdhOrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | ||||
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 | Σ | 1..1 | 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
qualification | S | 0..* | (Complex) | NDH Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification | ||||
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | ||||
logo | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Business identifiers that are specific to this role | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
identifier-status | S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | ||||
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) | ||||
active | SΣ | 1..1 | boolean | Whether this organization affiliation record is in active use Required Pattern: true | ||||
period | SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | ||||
organization | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization where the role is available | ||||
participatingOrganization | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that provides/performs the role (e.g. providing services or is a member of) | ||||
network | SΣ | 0..* | Reference(NDH Exchange Network Profile) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | ||||
code | SΣ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible) | ||||
specialty | SΣ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: Specialties Value Set (extensible) | ||||
location | SΣ | 0..* | Reference(NDH Exchange Location Profile) | The location(s) at which the role occurs | ||||
healthcareService | S | 0..* | Reference(NDH Exchange HealthcareService Profile) | Healthcare services provided through the role | ||||
telecom | SΣ | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation | ||||
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 | |||||
contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | ||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | SΣ | 0..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
endpoint | S | 0..* | Reference(NDH Exchange Endpoint Profile) | Technical endpoints providing access to services operated for this role | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
OrganizationAffiliation.meta.security | extensible | All Security Labels | ||||
OrganizationAffiliation.meta.tag | example | CommonTags | ||||
OrganizationAffiliation.language | preferred | CommonLanguages
| ||||
OrganizationAffiliation.identifier.use | required | IdentifierUse | ||||
OrganizationAffiliation.identifier.type | extensible | Identifier Type Codes | ||||
OrganizationAffiliation.code | extensible | OrganizationAffiliationRoleVS | ||||
OrganizationAffiliation.specialty | extensible | SpecialtiesVS | ||||
OrganizationAffiliation.telecom.system | required | ContactPointSystem | ||||
OrganizationAffiliation.telecom.use | required | ContactPointUse |
This structure is derived from NdhOrganizationAffiliation
Summary
Mandatory: 2 elements (3 nested mandatory elements)
Must-Support: 20 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from NdhOrganizationAffiliation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OrganizationAffiliation | 0..* | NdhOrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | |
meta | ||||
profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
extension | 1..* | Extension | Extension | |
extension:qualification | S | 0..* | Qualification | NDH Qualification |
extension:verification-status | S | 1..1 | VerificationStatus | NDH Verification Status |
identifier | ||||
extension | 1..* | Extension | Extension | |
extension:identifier-status | S | 1..1 | IdentifierStatus | NDH Identifier Status |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
type | S | 0..1 | CodeableConcept | Description of identifier |
system | S | 0..1 | uri | The namespace for the identifier value |
value | S | 0..1 | string | The value that is unique |
assigner | S | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
active | S | 1..1 | boolean | Whether this organization affiliation record is in active use |
organization | 0..1 | Reference(NDH Exchange Organization Profile) | Organization where the role is available | |
participatingOrganization | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that provides/performs the role (e.g. providing services or is a member of) | |
network | S | 0..* | Reference(NDH Exchange Network Profile) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) |
code | S | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays |
specialty | S | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role |
location | 0..* | Reference(NDH Exchange Location Profile) | The location(s) at which the role occurs | |
healthcareService | S | 0..* | Reference(NDH Exchange HealthcareService Profile) | Healthcare services provided through the role |
telecom | S | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation |
extension:contactpoint-availabletime | S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
extension:via-intermediary | S | 0..1 | ViaIntermediary | NDH Via Intermediary |
system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
value | S | 0..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
endpoint | 0..* | Reference(NDH Exchange Endpoint Profile) | Technical endpoints providing access to services operated for this role | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
OrganizationAffiliation | C | 0..* | NdhOrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
qualification | S | 0..* | (Complex) | NDH Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification |
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) |
logo | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Business identifiers that are specific to this role |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
identifier-status | S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) |
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
assigner | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
active | SΣ | 1..1 | boolean | Whether this organization affiliation record is in active use Required Pattern: true |
period | SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization |
organization | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization where the role is available |
participatingOrganization | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that provides/performs the role (e.g. providing services or is a member of) |
network | SΣ | 0..* | Reference(NDH Exchange Network Profile) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) |
code | SΣ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible) |
specialty | SΣ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: Specialties Value Set (extensible) |
location | SΣ | 0..* | Reference(NDH Exchange Location Profile) | The location(s) at which the role occurs |
healthcareService | S | 0..* | Reference(NDH Exchange HealthcareService Profile) | Healthcare services provided through the role |
telecom | SΣ | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation |
contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | SΣ | 0..1 | string | The actual contact point details |
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
endpoint | S | 0..* | Reference(NDH Exchange Endpoint Profile) | Technical endpoints providing access to services operated for this role |
Documentation for this format |
Path | Conformance | ValueSet |
OrganizationAffiliation.identifier.use | required | IdentifierUse |
OrganizationAffiliation.identifier.type | extensible | Identifier Type Codes |
OrganizationAffiliation.code | extensible | OrganizationAffiliationRoleVS |
OrganizationAffiliation.specialty | extensible | SpecialtiesVS |
OrganizationAffiliation.telecom.system | required | ContactPointSystem |
OrganizationAffiliation.telecom.use | required | ContactPointUse |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
OrganizationAffiliation | C | 0..* | NdhOrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | ||||
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 | Σ | 1..1 | 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
qualification | S | 0..* | (Complex) | NDH Qualification URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-qualification | ||||
usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | ||||
logo | 0..1 | Attachment | NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Business identifiers that are specific to this role | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
identifier-status | S | 1..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | ||||
use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) | ||||
active | SΣ | 1..1 | boolean | Whether this organization affiliation record is in active use Required Pattern: true | ||||
period | SΣ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | ||||
organization | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization where the role is available | ||||
participatingOrganization | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that provides/performs the role (e.g. providing services or is a member of) | ||||
network | SΣ | 0..* | Reference(NDH Exchange Network Profile) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | ||||
code | SΣ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliation Roles (extensible) | ||||
specialty | SΣ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: Specialties Value Set (extensible) | ||||
location | SΣ | 0..* | Reference(NDH Exchange Location Profile) | The location(s) at which the role occurs | ||||
healthcareService | S | 0..* | Reference(NDH Exchange HealthcareService Profile) | Healthcare services provided through the role | ||||
telecom | SΣ | 0..* | ContactPoint | Contact details at the participatingOrganization relevant to this Affiliation | ||||
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 | |||||
contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | ||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | SΣ | 0..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
endpoint | S | 0..* | Reference(NDH Exchange Endpoint Profile) | Technical endpoints providing access to services operated for this role | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
OrganizationAffiliation.meta.security | extensible | All Security Labels | ||||
OrganizationAffiliation.meta.tag | example | CommonTags | ||||
OrganizationAffiliation.language | preferred | CommonLanguages
| ||||
OrganizationAffiliation.identifier.use | required | IdentifierUse | ||||
OrganizationAffiliation.identifier.type | extensible | Identifier Type Codes | ||||
OrganizationAffiliation.code | extensible | OrganizationAffiliationRoleVS | ||||
OrganizationAffiliation.specialty | extensible | SpecialtiesVS | ||||
OrganizationAffiliation.telecom.system | required | ContactPointSystem | ||||
OrganizationAffiliation.telecom.use | required | ContactPointUse |
This structure is derived from NdhOrganizationAffiliation
Summary
Mandatory: 2 elements (3 nested mandatory elements)
Must-Support: 20 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron