Guia de Implementação do AnHealth
0.2.0 - CI Build
Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
| Draft as of 2023-08-28 |
Definitions for the OrganizationAffiliation resource profile.
| 1. OrganizationAffiliation | |
| 2. OrganizationAffiliation.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 10..* |
| Type | Identifier(Identifier) |
| 3. OrganizationAffiliation.active | |
| Control | 10..1 |
| 4. OrganizationAffiliation.period | |
| Control | 10..1 |
| 5. OrganizationAffiliation.organization | |
| Control | 10..1 |
| 6. OrganizationAffiliation.participatingOrganization | |
| Control | 10..1 |
| 7. OrganizationAffiliation.telecom | |
| Type | ContactPoint(ContactPoint) |
| 1. OrganizationAffiliation | |
| Definition | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship. |
| Control | 0..* |
| Invariants | Defined on this element dom-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.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: 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()) |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true |
| 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 3. 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). |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true |
| 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 Names | extensions, user content |
| 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. |
| Invariants | Defined on this element ele-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()) |
| 4. OrganizationAffiliation.identifier | |
| Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Business identifiers that are specific to this role. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 10..* This element is affected by the following invariants: ele-1 |
| Type | Identifier(Identifier) |
| Requirements | Often, specific identities are assigned for the agent. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) |
| 5. OrganizationAffiliation.active | |
| Definition | Whether this organization affiliation record is in active use. |
| Control | 10..1 |
| Type | boolean |
| 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. |
| 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. |
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 6. OrganizationAffiliation.period | |
| Definition | The period during which the participatingOrganization is affiliated with the primary organization. |
| Control | 10..1 |
| Type | Period |
| 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 7. OrganizationAffiliation.organization | |
| Definition | Organization where the role is available (primary organization/has members). |
| Control | 10..1 |
| Type | Reference(Organization)) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 8. 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). |
| Control | 10..1 |
| Type | Reference(Organization)) |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 9. OrganizationAffiliation.telecom | |
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. Contact details at the participatingOrganization relevant to this Affiliation. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | ContactPoint(ContactPoint) |
| Requirements | Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization. |
| Alternate Names | Contato, Informação de Contato, Telefone, E-Mail, Correio Eletrônico, Celular, Recado |
| Invariants | Defined on this element cpt-2: A system is required if a value is provided. (: value.empty() or system.exists()) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) |
| 1. OrganizationAffiliation | |||||
| Definition | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship. | ||||
| Control | 0..* | ||||
| 2. OrganizationAffiliation.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| 3. OrganizationAffiliation.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 4. 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. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true | ||||
| 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 5. OrganizationAffiliation.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages
IETF language ta
| ||||
| Type | code | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 6. OrganizationAffiliation.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrativehtmlxhtmldisplay | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 7. OrganizationAffiliation.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resourcesanonymous resourcescontained resources | ||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
| Invariants | Defined on this element dom-r4b: 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)) | ||||
| 8. OrganizationAffiliation.extension | |||||
| Definition | 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensionsuser content | ||||
| 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. | ||||
| Invariants | Defined on this element ele-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()) | ||||
| 9. 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). | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true | ||||
| 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 Names | extensionsuser content | ||||
| 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. | ||||
| Invariants | Defined on this element ele-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 | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 1..* This element is affected by the following invariants: ele-1 | ||||
| Type | Identifier(Identifier) | ||||
| Requirements | Often, specific identities are assigned for the agent. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 11. OrganizationAffiliation.active | |||||
| Definition | Whether this organization affiliation record is in active use. | ||||
| Control | 1..1 | ||||
| Type | boolean | ||||
| 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. | ||||
| 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. | ||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 12. OrganizationAffiliation.period | |||||
| Definition | The period during which the participatingOrganization is affiliated with the primary organization. | ||||
| Control | 1..1 | ||||
| Type | Period | ||||
| 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. | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 13. OrganizationAffiliation.organization | |||||
| Definition | Organization where the role is available (primary organization/has members). | ||||
| Control | 1..1 | ||||
| Type | Reference(Organization)) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 14. 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). | ||||
| Control | 1..1 | ||||
| Type | Reference(Organization)) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 15. OrganizationAffiliation.network | |||||
| Definition | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined). | ||||
| Control | 0..* | ||||
| Type | Reference(Organization)) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 16. OrganizationAffiliation.code | |||||
| Definition | Definition of the role the participatingOrganization plays in the association. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see OrganizationAffiliationRole The role the participating organization providing services to the primary organization | ||||
| Type | CodeableConcept | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 17. OrganizationAffiliation.specialty | |||||
| Definition | Specific specialty of the participatingOrganization in the context of the role. | ||||
| Control | 0..* | ||||
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet Specific specialty associated with the participating organization | ||||
| Type | CodeableConcept | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 18. OrganizationAffiliation.location | |||||
| Definition | The location(s) at which the role occurs. | ||||
| Control | 0..* | ||||
| Type | Reference(Location)) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 19. OrganizationAffiliation.healthcareService | |||||
| Definition | Healthcare services provided through the role. | ||||
| Control | 0..* | ||||
| Type | Reference(HealthcareService)) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
| 20. OrganizationAffiliation.telecom | |||||
| Definition | Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | ContactPoint(ContactPoint) | ||||
| Requirements | Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization. | ||||
| Alternate Names | ContatoInformação de ContatoTelefoneE-MailCorreio EletrônicoCelularRecado | ||||
| Invariants | Defined on this element cpt-2: A system is required if a value is provided. (: value.empty() or system.exists()) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (: hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 21. OrganizationAffiliation.endpoint | |||||
| Definition | Technical endpoints providing access to services operated for this role. | ||||
| Control | 0..* | ||||
| Type | Reference(Endpoint)) | ||||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||