Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
Resource Profile: OrganizationAffiliation
| Official URL: https://ancode.app/fhir/StructureDefinition/OrganizationAffiliation | Version: 0.2.0 | |||
| Draft as of 2023-08-28 | Computable Name: OrganizationAffiliation | |||
Usage:
- This Resource Profile is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from OrganizationAffiliation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  OrganizationAffiliation | 0..* | OrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | |
  identifier | 1..* | Identifier | An identifier intended for computation | |
 active | 1..1 | boolean | Whether this organization affiliation record is in active use | |
| period | 1..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | |
| organization | 1..1 | Reference(Organization) | Organization where the role is available | |
| participatingOrganization | 1..1 | Reference(Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) | |
 telecom | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OrganizationAffiliation | 0..* | OrganizationAffiliation | 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 |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 1..* | Identifier | An identifier intended for computation | |
| active | Σ | 1..1 | boolean | Whether this organization affiliation record is in active use |
| period | Σ | 1..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization |
 organization | Σ | 1..1 | Reference(Organization) | Organization where the role is available |
| participatingOrganization | Σ | 1..1 | Reference(Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) |
| telecom | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | OrganizationAffiliation.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | OrganizationAffiliation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | OrganizationAffiliation | 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | OrganizationAffiliation | 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 | error | OrganizationAffiliation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | OrganizationAffiliation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| OrganizationAffiliation | 0..* | OrganizationAffiliation | 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 | ||||
| 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): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 1..* | Identifier | An identifier intended for computation | |||||
| active | Σ | 1..1 | boolean | Whether this organization affiliation record is in active use | ||||
| period | Σ | 1..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | ||||
| organization | Σ | 1..1 | Reference(Organization) | Organization where the role is available | ||||
| participatingOrganization | Σ | 1..1 | Reference(Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) | ||||
| network | Σ | 0..* | Reference(Organization) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | ||||
| code | Σ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization. | ||||
| specialty | Σ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization. | ||||
| location | Σ | 0..* | Reference(Location) | The location(s) at which the role occurs | ||||
| healthcareService | 0..* | Reference(HealthcareService) | Healthcare services provided through the role | |||||
| telecom | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for this role | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| OrganizationAffiliation.language | preferred | CommonLanguages
| ||||
| OrganizationAffiliation.code | example | OrganizationAffiliationRole | ||||
| OrganizationAffiliation.specialty | preferred | PracticeSettingCodeValueSet |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | OrganizationAffiliation.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-r4b | warning | OrganizationAffiliation.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from OrganizationAffiliation
Differential View
This structure is derived from OrganizationAffiliation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OrganizationAffiliation | 0..* | OrganizationAffiliation | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship | |
| identifier | 1..* | Identifier | An identifier intended for computation | |
| active | 1..1 | boolean | Whether this organization affiliation record is in active use | |
| period | 1..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | |
| organization | 1..1 | Reference(Organization) | Organization where the role is available | |
| participatingOrganization | 1..1 | Reference(Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) | |
| telecom | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OrganizationAffiliation | 0..* | OrganizationAffiliation | 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 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 1..* | Identifier | An identifier intended for computation | |
| active | Σ | 1..1 | boolean | Whether this organization affiliation record is in active use |
| period | Σ | 1..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization |
| organization | Σ | 1..1 | Reference(Organization) | Organization where the role is available |
| participatingOrganization | Σ | 1..1 | Reference(Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) |
| telecom | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | OrganizationAffiliation.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-2 | error | OrganizationAffiliation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | OrganizationAffiliation | 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | OrganizationAffiliation | 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 | error | OrganizationAffiliation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | OrganizationAffiliation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| OrganizationAffiliation | 0..* | OrganizationAffiliation | 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 | ||||
| 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): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 1..* | Identifier | An identifier intended for computation | |||||
| active | Σ | 1..1 | boolean | Whether this organization affiliation record is in active use | ||||
| period | Σ | 1..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | ||||
| organization | Σ | 1..1 | Reference(Organization) | Organization where the role is available | ||||
| participatingOrganization | Σ | 1..1 | Reference(Organization) | Organization that provides/performs the role (e.g. providing services or is a member of) | ||||
| network | Σ | 0..* | Reference(Organization) | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | ||||
| code | Σ | 0..* | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization. | ||||
| specialty | Σ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization. | ||||
| location | Σ | 0..* | Reference(Location) | The location(s) at which the role occurs | ||||
| healthcareService | 0..* | Reference(HealthcareService) | Healthcare services provided through the role | |||||
| telecom | C | 0..* | ContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for this role | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| OrganizationAffiliation.language | preferred | CommonLanguages
| ||||
| OrganizationAffiliation.code | example | OrganizationAffiliationRole | ||||
| OrganizationAffiliation.specialty | preferred | PracticeSettingCodeValueSet |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | OrganizationAffiliation.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| dom-r4b | warning | OrganizationAffiliation.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from OrganizationAffiliation
Other representations of profile: CSV, Excel, Schematron