REDS GO
1.0.0 - draft Brazil flag

REDS GO - Downloaded Version 1.0.0 See the Directory of published versions

Extension: BRAdministradorTerceiro - Detailed Descriptions

Active as of 2020-03-13

Definitions for the BRAdministradorTerceiro-1.0 extension.

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. Extension
Definição

Identifica organizações que são gerentes/administradoras (terceiras) ou intervenientes de outras.


Optional Extension Element - found in all resources.

CurtoGerente/Administrador (Terceiro) ou IntervenienteOptional Extensions Element
Controlo0..*
Este elemento é afetado pelas seguintes invariantes: ele-1
É modificadorfalse
Invariantesele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.url
Definição

Source of the definition for the extension code - a logical name or a URL.

Curtoidentifies the meaning of the extension
Comentários

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Controlo1..1
Tipouri
É modificadorfalse
Formato XMLNo formato XML, esta propriedade é representada como um atributo.
Resumofalse
Valor fixohttp://www.saude.gov.br/fhir/r4/StructureDefinition/BRAdministradorTerceiro-1.0
4. Extension.value[x]
Definição

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

CurtoValue of extension
Controlo10..1
TipoReference(Pessoa Jurídica e Profissional Liberal), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
É modificadorfalse
Resumofalse
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Extension.value[x].reference
Definição

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

CurtoLiteral reference, Relative, internal or absolute URL
Comentários

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Controlo10..1
Este elemento é afetado pelas seguintes invariantes: ref-1
Tipostring
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Extension.value[x].type
Definição

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

CurtoType the reference refers to (e.g. "Patient")
Comentários

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Controlo0..01
VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
(extensible to http://hl7.org/fhir/ValueSet/resource-types)

Aa resource (or, for logical models, the URI of the logical model).

Tipouri
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Extension.value[x].identifier
Definição

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

CurtoLogical reference, when literal reference is not known
Comentários

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo0..01
TipoIdentifier
É modificadorfalse
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Extension.value[x].display
Definição

Plain text narrative that identifies the resource in addition to the resource reference.

CurtoText alternative for the resource
Comentários

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Controlo0..01
Tipostring
É modificadorfalse
Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
Resumotrue
Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. Extension
Definição

Identifica organizações que são gerentes/administradoras (terceiras) ou intervenientes de outras.

CurtoGerente/Administrador (Terceiro) ou Interveniente
2. Extension.url
Valor fixohttp://www.saude.gov.br/fhir/r4/StructureDefinition/BRAdministradorTerceiro-1.0
4. Extension.value[x]
Controlo1..?
TipoReference(Pessoa Jurídica e Profissional Liberal), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
6. Extension.value[x].reference
Controlo1..?
8. Extension.value[x].type
Controlo0..0
10. Extension.value[x].identifier
NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
Controlo0..0
12. Extension.value[x].display
Controlo0..0

Instruções sobre como interpretar o conteúdo desta tabela podem ser encontradashere

0. Extension
Definição

Identifica organizações que são gerentes/administradoras (terceiras) ou intervenientes de outras.

CurtoGerente/Administrador (Terceiro) ou Interveniente
Controlo0..*
Este elemento é afetado pelas seguintes invariantes: ele-1
É modificadorfalse
Invariantesele-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())
2. Extension.id
Definição

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

CurtoUnique id for inter-element referencing
Controlo0..1
Tipostring
É modificadorfalse
Formato XMLNo formato XML, esta propriedade é representada como um atributo.
Resumofalse
4. Extension.extension
Definição

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.

CurtoAdditional content defined by implementations
Comentários

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.

Controlo0..*
TipoExtension
É modificadorfalse
Resumofalse
Nomes alternativosextensions, user content
Invariantesele-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())
SlicingEste elemento introduz um conjunto de fatias em Extension.extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
  • value @ url
  • 6. Extension.url
    Definição

    Source of the definition for the extension code - a logical name or a URL.

    Curtoidentifies the meaning of the extension
    Comentários

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Controlo1..1
    Tipouri
    É modificadorfalse
    Formato XMLNo formato XML, esta propriedade é representada como um atributo.
    Resumofalse
    Valor fixohttp://www.saude.gov.br/fhir/r4/StructureDefinition/BRAdministradorTerceiro-1.0
    8. Extension.value[x]
    Definição

    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    CurtoValue of extension
    Controlo1..1
    TipoReference(Pessoa Jurídica e Profissional Liberal)
    [x] NotaVerEscolha de tipos de dadospara mais informações sobre como utilizar [x]
    É modificadorfalse
    Resumofalse
    Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Extension.value[x].id
    Definição

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

    CurtoUnique id for inter-element referencing
    Controlo0..1
    Tipostring
    É modificadorfalse
    Formato XMLNo formato XML, esta propriedade é representada como um atributo.
    Resumofalse
    12. Extension.value[x].extension
    Definição

    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.

    CurtoAdditional content defined by implementations
    Comentários

    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.

    Controlo0..*
    TipoExtension
    É modificadorfalse
    Resumofalse
    Nomes alternativosextensions, user content
    Invariantesele-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())
    SlicingEste elemento introduz um conjunto de fatias em Extension.value[x].extension. As fatias sãoNão ordenado e Opene pode ser diferenciado utilizando os seguintes discriminadores:
    • value @ url
    • 14. Extension.value[x].reference
      Definição

      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

      CurtoLiteral reference, Relative, internal or absolute URL
      Comentários

      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

      Controlo1..1
      Este elemento é afetado pelas seguintes invariantes: ref-1
      Tipostring
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      16. Extension.value[x].type
      Definição

      The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

      The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

      CurtoType the reference refers to (e.g. "Patient")
      Comentários

      This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

      Controlo0..0
      VínculoA menos que não sejam adequados, estes códigos DEVERÃO ser retirados de ResourceType
      (extensible to http://hl7.org/fhir/ValueSet/resource-types)

      Aa resource (or, for logical models, the URI of the logical model).

      Tipouri
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      18. Extension.value[x].identifier
      Definição

      An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

      CurtoLogical reference, when literal reference is not known
      Comentários

      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

      Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

      NotaTrata-se de um identificador de empresa e não de um identificador de recurso (ver discussão)
      Controlo0..0
      TipoIdentifier
      É modificadorfalse
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Extension.value[x].display
      Definição

      Plain text narrative that identifies the resource in addition to the resource reference.

      CurtoText alternative for the resource
      Comentários

      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

      Controlo0..0
      Tipostring
      É modificadorfalse
      Valor primitivoEste elemento primitivo pode estar presente, ausente ou ser substituído por uma extensão
      Resumotrue
      Invariantesele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))