BR.GOV.SAUDE.IPS.FHIR\PractitionerRoleBRIPS - Definitions

idstring

Is Modifier false

Summary true

4. PractitionerRole.meta

Definition

Metadados sobre o recurso

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.

Short Metadados sobre o recursoMetadata about the resource

Control 0..1

Meta

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. PractitionerRole.implicitRules

Definition

Conjunto de regras sob as quais este conteúdo foi criado

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.

Short Conjunto de regras sob as quais este conteúdo foi criadoA 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.

Control 0..1

uri

Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. PractitionerRole.language

Definition

Idioma do conteúdo do recurso

The base language in which the resource is written.

Short Idioma do conteúdo do recursoLanguage of the resource content

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).

Control 0..1

The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. PractitionerRole.text

Definition

Resumo textual do recurso em linguagem natural

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.

Short Resumo textual do recurso em linguagem naturalText summary of the resource, for human interpretation

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.

Control 0..1

Narrative

Is Modifier false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. PractitionerRole.contained

Definition

Recursos contidos em linha

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.

Short Recursos contidos em linhaContained, inline 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.

Control 0..*

Resource

Is Modifier false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

14. PractitionerRole.modifierExtension

Definition

Extensão que não pode ser ignorada

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).

Short Extensão que não pode ser ignoradaExtensions 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.

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Summary false

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

Invariants 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())

16. PractitionerRole.identifier

Definition

Identificadores externos para este item

Business Identifiers that are specific to a role/location.

Short Identificadores externos para este itemBusiness Identifiers that are specific to a role/location

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Identifier

Is Modifier false

Summary true

Requirements

Often, specific identities are assigned for the agent.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

18. PractitionerRole.active

Definition

Whether this practitioner role record is in active use.

Short Informa de o registro de função do profissional está em uso ativoWhether this practitioner role 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.

Control 0..1

boolean

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary true

Requirements

Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.

Meaning if Missing This resource is generally assumed to be active if no value is provided for the active element

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

20. PractitionerRole.period

Definition

Período durante o qual o profissional está autorizado a exercer essa(s) função(ões).

The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

Short Período durante o qual o profissional está autorizado a exercer essa(s) função(ões).The period during which the practitioner is authorized to perform in these role(s)

Control 0..1

Period

Is Modifier false

Summary true

Requirements

Even after the agencies is revoked, the fact that it existed must still be recorded.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

22. PractitionerRole.practitioner

Definition

Profissional capaz de fornecer os serviços definidos para a organização

Practitioner that is able to provide the defined services for the organization.

Short Profissional capaz de fornecer os serviços definidos para a organizaçãoPractitioner that is able to provide the defined services for the organization

Control 0..1

Type Reference(PractitionerBRIPS, Practitioner)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

24. PractitionerRole.organization

Definition

Organização onde as funções estão disponíveis.

The organization where the Practitioner performs the roles associated.

Short Organização onde as funções estão disponíveis.Organization where the roles are available

Control 0..1

Type Reference(OrganizationBRIPS, Organization)

Is Modifier false

Must Support true

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

26. PractitionerRole.code

Definition

Códigos dos papeis dos profissionais de saúde.

Roles which this practitioner is authorized to perform for the organization.

Short Códigos dos papeis dos profissionais de saúde.Roles which this practitioner may perform

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

A person may have more than one role.

Control 0..*
This element is affected by the following invariants: ele-1

The codes SHOULD be taken from For example codes, see Healthcare Professional Roles - IPShttp://hl7.org/fhir/ValueSet/practitioner-role
(preferred to http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips)

Healthcare professional role codes from International Standard Classification of Occupations (ISCO).

The role a person plays representing an organization.

Type CodeableConcept(Codeable Concept (IPS))

Is Modifier false

Requirements

Need to know what authority the practitioner has - what can they do?

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

28. PractitionerRole.specialty

Definition

Especialidade específica do profissional.

Specific specialty of the practitioner.

Short Especialidade específica do profissional.Specific specialty of the practitioner

Control 0..*

The codes SHOULD be taken from PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes
(preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes)

Specific specialty associated with the agency.

CodeableConcept

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

30. PractitionerRole.location

Definition

Local em que este profissional presta cuidados.

The location(s) at which this practitioner provides care.

Short Local em que este profissional presta cuidados.The location(s) at which this practitioner provides care

Control 0..*

Type Reference(Location)

Is Modifier false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

32. PractitionerRole.healthcareService

Definition

A lista de serviços de saúde que este profissional fornece para a organização/local(is) desta função.

The list of healthcare services that this worker provides for this role's Organization/Location(s).

Short A lista de serviços de saúde que este profissional fornece para a organização/local(is) desta função.The list of healthcare services that this worker provides for this role's Organization/Location(s)

Control 0..*

Type Reference(HealthcareService)

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

34. PractitionerRole.telecom

Definition

Detalhes de contato específicos para a função/local/serviço.

Contact details that are specific to the role/location/service.

Short Detalhes de contato específicos para a função/local/serviço.Contact details that are specific to the role/location/service

Control 0..*

ContactPoint

Is Modifier false

Summary true

Requirements

Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

36. PractitionerRole.availableTime

Definition

Horários em que o site do serviço está disponível.

A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

Short Horários em que o site do serviço está disponível.Times the Service Site is available

Comments

More detailed availability information may be provided in associated Schedule/Slot resources.

Control 0..*

BackboneElement

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

38. PractitionerRole.availableTime.id

Definition

ID exclusivo para referência entre elementos.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short ID exclusivo para referência entre elementos.Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

40. PractitionerRole.availableTime.extension

Definition

Conteúdo adicional definido por implementações.

May be used to represent additional information that is not part of the basic definition of the element. 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.

Short Conteúdo adicional definido por implementações.Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

42. PractitionerRole.availableTime.modifierExtension

Definition

Extensões que não podem ser ignoradas mesmo que não sejam reconhecidas.

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

Short Extensões que não podem ser ignoradas mesmo que não sejam reconhecidas.Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

44. PractitionerRole.availableTime.daysOfWeek

Definition

Dias da semana: seg| ter| qua| qui| sex| sab | dom.

Indicates which days of the week are available between the start and end Times.

Short Dias da semana: seg| ter| qua| qui| sex| sab | dom.mon | tue | wed | thu | fri | sat | sun

Control 0..*

The codes SHALL be taken from DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1
(required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1)

The days of the week.

code

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

46. PractitionerRole.availableTime.allDay

Definition

Sempre disponível? por exemplo: serviço 24 horas.

Is this always available? (hence times are irrelevant) e.g. 24 hour service.

Short Sempre disponível? sim ou não, por exemplo: serviço 24 horas.Always available? e.g. 24 hour service

Control 0..1

boolean

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

48. PractitionerRole.availableTime.availableStartTime

Definition

Hora de abertura do dia (ignorado se allDay = true)

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

Short Hora de abertura do dia (ignorado se allDay = true)Opening time of day (ignored if allDay = true)

Comments

The timezone is expected to be for where this HealthcareService is provided at.

Control 0..1

time

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

50. PractitionerRole.availableTime.availableEndTime

Definition

Horário de fechamento do dia (ignorado se allDay = true).

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

Short Horário de fechamento do dia (ignorado se allDay = true).Closing time of day (ignored if allDay = true)

Comments

The timezone is expected to be for where this HealthcareService is provided at.

Control 0..1

time

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

52. PractitionerRole.notAvailable

Definition

Não disponível durante este período devido ao motivo fornecido.

The practitioner is not available or performing this role during this period of time due to the provided reason.

Short Não disponível durante este período devido ao motivo fornecido.Not available during this time due to provided reason

Control 0..*

BackboneElement

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

54. PractitionerRole.notAvailable.id

Definition

ID exclusivo para referência entre elementos.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short ID exclusivo para referência entre elementos.Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

56. PractitionerRole.notAvailable.extension

Definition

Conteúdo adicional definido por implementações.

Short Conteúdo adicional definido por implementações.Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

58. PractitionerRole.notAvailable.modifierExtension

Definition

Extensões que não podem ser ignoradas mesmo que não sejam reconhecidas.

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

Short Extensões que não podem ser ignoradas mesmo que não sejam reconhecidas.Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

60. PractitionerRole.notAvailable.description

Definition

Motivo apresentado ao usuário explicando porque o horário não está disponível.

The reason that can be presented to the user as to why this time is not available.

Short Motivo apresentado ao usuário explicando porque o horário não está disponível.Reason presented to the user explaining why time not available

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

62. PractitionerRole.notAvailable.during

Definition

Serviço indisponível a partir desta data.

Service is not available (seasonally or for a public holiday) from this date.

Short Serviço indisponível a partir desta data.Service not available from this date

Control 0..1

Period

Is Modifier false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

64. PractitionerRole.availabilityExceptions

Definition

Descrição da disponibilidade das exceções.

A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

Short Descrição da disponibilidade das exceções.Description of availability exceptions

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

66. PractitionerRole.endpoint

Definition

Endpoints que fornecem acesso a serviços operados para o profissional com esta função.

Technical endpoints providing access to services operated for the practitioner with this role.

Short Endpoints que fornecem acesso a serviços operados para o profissional com esta função.Technical endpoints providing access to services operated for the practitioner with this role

Control 0..*

Type Reference(Endpoint)

Is Modifier false

Summary false

Requirements

Organizations have multiple systems that provide various services and ,ay also be different for practitioners too.

So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

0. PractitionerRole

Definition

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Short Roles/organizations the practitioner is associated with

Control 0..*

Is Modifier false

Summary false

Invariants 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 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())

2. PractitionerRole.id

Definition

ID lógico deste artefato

Short ID lógico deste artefato

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.

Control 0..1

Is Modifier false

Summary true

4. PractitionerRole.meta

Definition

Metadados sobre o recurso

Short Metadados sobre o recurso

Control 0..1