Da Vinci PDex Plan Net
1.2.0 - STU1.2 United States of America flag

Da Vinci PDex Plan Net, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pdex-plan-net/ and changes regularly. See the Directory of published versions

Resource Profile: PlannetOrganizationAffiliation - Detailed Descriptions

Page standards status: Trial-use

Definitions for the plannet-OrganizationAffiliation resource profile.

Guidance on how to interpret the contents of this table can be found here

0. OrganizationAffiliation
Definition

Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.

ShortDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
organization-or-participatingOrganization: PlannetOrganizationAffiliation.organization or PlannetOrganizationAffiliation.participatingOrganization (organization.exists() or participatingOrganization.exists())
2. OrganizationAffiliation.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. OrganizationAffiliation.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on OrganizationAffiliation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. OrganizationAffiliation.extension:qualification
    Slice Namequalification
    Definition

    An extension to add qualifications for an organization (e.g. accreditation) or practitionerRole (e.g. registered to prescribe controlled substances).

    ShortQualification
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Qualification) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. OrganizationAffiliation.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. OrganizationAffiliation.identifier
    Definition

    Business identifiers that are specific to this role.

    ShortBusiness identifiers that are specific to this role
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Is Modifierfalse
    Summarytrue
    Requirements

    Often, specific identities are assigned for the agent.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. OrganizationAffiliation.identifier.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control0..1
    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. OrganizationAffiliation.identifier.type
    Definition

    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

    ShortDescription of identifier
    Comments

    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type
    (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Allows users to make use of identifiers when the identifier system is not known.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. OrganizationAffiliation.identifier.value
    Definition

    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    ShortThe value that is unique
    Comments

    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Example<br/><b>General</b>:123456
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. OrganizationAffiliation.active
    Definition

    Whether this organization affiliation record is in active use.

    ShortWhether this organization affiliation record is in active use
    Comments

    If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.

    Control10..1
    Typeboolean
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use.

    Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
    Pattern Valuetrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. OrganizationAffiliation.period
    Definition

    The period during which the participatingOrganization is affiliated with the primary organization.

    ShortThe period during which the participatingOrganization is affiliated with the primary organization
    Control0..1
    TypePeriod
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    An affiliation may be created ahead of time and only be active for a defined period of time. Once the affiliation is complete, the fact that it existed may still be required.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. OrganizationAffiliation.organization
    Definition

    Organization where the role is available (primary organization/has members).

    ShortOrganization where the role is available
    Control0..1
    TypeReference(Plan-Net Organization, Organization)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. OrganizationAffiliation.participatingOrganization
    Definition

    The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).

    ShortOrganization that provides/performs the role (e.g. providing services or is a member of)
    Control0..1
    TypeReference(Plan-Net Organization, Organization)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. OrganizationAffiliation.network
    Definition

    Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).

    ShortHealth insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
    Control0..*
    TypeReference(Plan-Net Network, Organization)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. OrganizationAffiliation.code
    Definition

    Definition of the role the participatingOrganization plays in the association.

    ShortDefinition of the role the participatingOrganization plays
    Control0..*
    BindingUnless not suitable, these codes SHALL be taken from For example codes, see OrganizationAffiliation Roleshttp://hl7.org/fhir/ValueSet/organization-role
    (extensible to http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/OrganizationAffiliationRoleVS)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. OrganizationAffiliation.specialty
    Definition

    Specific specialty of the participatingOrganization in the context of the role.

    ShortSpecific specialty of the participatingOrganization in the context of the role
    Control0..*
    BindingThe codes SHALL be taken from The codes SHOULD be taken from Specialties VShttp://hl7.org/fhir/ValueSet/c80-practice-codes
    (required to http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/SpecialtiesVS)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. OrganizationAffiliation.location
    Definition

    The location(s) at which the role occurs.

    ShortThe location(s) at which the role occurs
    Control0..*
    TypeReference(Plan-Net Location, Location)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. OrganizationAffiliation.healthcareService
    Definition

    Healthcare services provided through the role.

    ShortHealthcare services provided through the role
    Control0..*
    TypeReference(Plan-Net HealthcareService, HealthcareService)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. OrganizationAffiliation.telecom
    Definition

    Contact details at the participatingOrganization relevant to this Affiliation.

    ShortContact details at the participatingOrganization relevant to this Affiliation
    Control0..*
    TypeContactPoint
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. OrganizationAffiliation.telecom.system
    Definition

    Telecommunications form for contact point - what communications system is required to make use of the contact.

    Shortphone | fax | email | pager | url | sms | other
    Control0..1
    This element is affected by the following invariants: cpt-2
    BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
    (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

    Telecommunications form for contact point.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. OrganizationAffiliation.telecom.value
    Definition

    The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

    ShortThe actual contact point details
    Comments

    Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to support legacy numbers that are not in a tightly controlled format.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. OrganizationAffiliation.telecom.use
    Definition

    Identifies the purpose for the contact point.

    Shorthome | work | temp | old | mobile - purpose of this contact point
    Comments

    Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

    Control0..1
    BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
    (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

    Use of contact point.

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. OrganizationAffiliation.telecom.rank
    Definition

    Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

    ShortSpecify preferred order of use (1 = highest)
    Comments

    Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

    Control0..1
    TypepositiveInt
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. OrganizationAffiliation.endpoint
    Definition

    Technical endpoints providing access to services operated for this role.

    ShortTechnical endpoints providing access to services operated for this role
    Control0..*
    TypeReference(Plan-Net Endpoint, Endpoint)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))