Guia de Implemementacion FHIR Servicio Extremeño de Salud (SES)

Element id

Patient.id

Short description

Identificador lógico asociado al recurso

Definition

Identificador lógico del recurso, usado en la URL del mismo, una vez asignado este valor nunca cambia.

Comments

El único momento en que un recurso no tiene id es cuando está siendo enviado al servidor usando una operación de creación.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Patient.meta

Short description

Metadata about the resource

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.

Data type

Constraints

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

implicitRules

Σ ?!

0..0

There are no (further) constraints on this element

Element id

Patient.implicitRules

Short description

A set of rules under which this content was created

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.

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.

Data type

Constraints

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

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Patient.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

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

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

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

text

0..0

There are no (further) constraints on this element

Element id

Patient.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

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.

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.

Data type

Constraints

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

Mappings

rim: Act.text?

contained

0..*

Element id

Patient.contained

Short description

Planned participants in the coordination and delivery of care for a patient or group

Alternate names

inline resources, anonymous resources, contained resources

Definition

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.

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.

Data type

Constraints

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

Mappings

rim: N/A
rim: Entity. Role, or Act

0..1

Element id

Patient.contained.id

Short description

Identificador secuencial del careteam

Definition

Este identificador se tiene que corresponder con uno existente en la extensión patient-careteam del recurso paciente.

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.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Patient.contained.meta

Short description

Metadata about the resource

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.

Data type

Constraints

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

implicitRules

Σ ?!

0..0

There are no (further) constraints on this element

Element id

Patient.contained.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

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

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Patient.contained.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

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

text

0..0

There are no (further) constraints on this element

Element id

Patient.contained.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

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

Mappings

rim: Act.text?

contained

0..0

There are no (further) constraints on this element

Element id

Patient.contained.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

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.

Comments

Data type

Mappings

rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

Patient.contained.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

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.

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.

Data type

Slicing

Unordered, Open, by url(Value)

Constraints

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

Mappings

rim: N/A

temporalidad

0..*

There are no (further) constraints on this element

Element id

Patient.contained.extension:temporalidad

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/careteam/temporality

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

motivo

0..*

There are no (further) constraints on this element

Element id

Patient.contained.extension:motivo

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/careteam/reason

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Patient.contained.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

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

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.

Comments

Data type

Constraints

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

Mappings

rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

Patient.contained.identifier

Short description

External Ids for this team

Definition

Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Requirements

Allows identification of the care team as it is known by various participating systems and in a way that remains consistent across servers.

Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

Data type

Constraints

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

Mappings

w5: FiveWs.identifier

status

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.contained.status

Short description

proposed | active | suspended | inactive | entered-in-error

Definition

Indicates the current state of the care team.

Comments

This element is labeled as a modifier because the status contains the code entered-in-error that marks the care team as not currently valid.

Data type

Binding

Indicates the status of the care team.

CareTeamStatus (required)

Constraints

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

Mappings

w5: FiveWs.status

category

0..*

There are no (further) constraints on this element

Element id

Patient.contained.category

Short description

Type of team

Definition

Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.

Requirements

Used for filtering what teams(s) are retrieved and displayed to different types of users.

Comments

There may be multiple axis of categorization and one team may serve multiple purposes.

Data type

Binding

Indicates the type of care team.

CareTeamCategory (example)

Constraints

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

Mappings

w5: FiveWs.class

0..0

There are no (further) constraints on this element

Element id

Patient.contained.category.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.contained.category.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

coding

0..2

There are no (further) constraints on this element

Element id

Patient.contained.category.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

El primer coding define el tipo de careteam, se corresponde con el catálogo indicado, tipo_adscripcion, el segundo coding se recibe solo si el primer tipo es ADSRL e indica el tipo de login que le ha asignado el paciente al representante legal, ADSTUTELAFU/ADSLTUTELADE.

Data type

Constraints

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

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

Patient.contained.category.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.contained.category.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

system

0..0

There are no (further) constraints on this element

Element id

Patient.contained.category.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data type

Constraints

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

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

Patient.contained.category.coding.version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Data type

Constraints

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

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.contained.category.coding.code

Short description

Código del tipo de careteam

Definition

Código del tipo de careteam, se corresponde con el catálogo existente en Ontology, tipo_adscripción.

Requirements

Need to refer to a particular code in the system.

Data type

http://hl7.org/fhir/CodeSystem/tipo_adscripcion (required)

Binding

Code

Constraints

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

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

stringBinding

There are no (further) constraints on this element

Element id

Patient.contained.category.coding.display

Short description

Descripción del tipo de Careteam

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

http://hl7.org/fhir/CodeSystem/tipo_adscripcion (required)

Binding

Display

Constraints

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

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

Patient.contained.category.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data type

Constraints

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

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

Patient.contained.category.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

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

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

name

0..0

There are no (further) constraints on this element

Element id

Patient.contained.name

Short description

Nombre completo del cuidador/representante

Definition

Nombre completo del cuidador/representante

Comments

The meaning/purpose of the team is conveyed in CareTeam.category. This element may also convey semantics of the team (e.g. "Red trauma team"), but its primary purpose is to distinguish between identical teams in a human-friendly way. ("Team 18735" isn't as friendly.).

Data type

Constraints

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

subject

0..1

Reference(Patient | Group)

There are no (further) constraints on this element

Element id

Patient.contained.subject

Short description

Identificador lógico del cuidador/representante

Alternate names

patient

Definition

Identificador lógico del cuidador/representante

Requirements

Allows the team to care for a group (e.g. marriage) therapy. Allows for an organization to designate a team such as the PICC line team.

Data type

Reference(Patient | Group)

Constraints

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

Mappings

w5: FiveWs.subject[x]
w5: FiveWs.subject

0..0

There are no (further) constraints on this element

Element id

Patient.contained.subject.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.contained.subject.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.contained.subject.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

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.

Comments

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

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

Mappings

rim: N/A

type

0..1

uriBindingFixed Value

There are no (further) constraints on this element

Element id

Patient.contained.subject.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

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

Comments

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.

Data type

Binding

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

Constraints

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

Fixed value

Patient

Mappings

rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

Patient.contained.subject.identifier

Short description

Logical reference, when literal reference is not known

Definition

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.

Comments

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

Data type

Constraints

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

Mappings

rim: .identifier

display

0..0

There are no (further) constraints on this element

Element id

Patient.contained.subject.display

Short description

Text alternative for the resource

Definition

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

Comments

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.

Data type

Constraints

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

Mappings

rim: N/A

encounter

0..0

Reference(Encounter)

There are no (further) constraints on this element

Element id

Patient.contained.encounter

Short description

Encounter created as part of

Definition

The Encounter during which this CareTeam was created or to which the creation of this record is tightly associated.

Comments

This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

Data type

Reference(Encounter)

Constraints

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

Mappings

w5: FiveWs.context

period

0..1

There are no (further) constraints on this element

Element id

Patient.contained.period

Short description

Time period team covers

Definition

Indicates when the team did (or is intended to) come into effect and end.

Requirements

Allows tracking what team(s) are in effect at a particular time.

Data type

Constraints

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

Mappings

w5: FiveWs.init

0..0

There are no (further) constraints on this element

Element id

Patient.contained.period.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.contained.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

start

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.contained.period.start

Short description

Inicio del periodo de careteam

Definition

Inicio del periodo de careteam

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

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

Mappings

v2: DR.1
rim: ./low

end

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.contained.period.end

Short description

Fin del periodo de careteam

Definition

Fin del periodo de careteam

Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

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

Mappings

v2: DR.2
rim: ./high

participant

0..*

There are no (further) constraints on this element

Element id

Patient.contained.participant

Short description

Members of the team

Definition

Identifies all people and organizations who are expected to be involved in the care team.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ctm-1

Constraints

ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
onBehalfOf.exists() implies (member.resolve().iif(empty(), true, ofType(Practitioner).exists()))
ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: REL (REL.4 is always the Patient) ( or PRT?)
rim: .participation[typeCode=PRF]

0..0

There are no (further) constraints on this element

Element id

Patient.contained.participant.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.contained.participant.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Constraints

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

Mappings

rim: n/a

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Patient.contained.participant.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

Constraints

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

Mappings

rim: N/A

role

0..*

There are no (further) constraints on this element

Element id

Patient.contained.participant.role

Short description

Relación con la persona cuidada/representada

Definition

Relación con la persona cuidada/representada

Comments

Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care team. General relationships should be handled as properties of the Patient resource directly.

Data type

Binding

Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.

ParticipantRoles (example)

Constraints

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

Mappings

v2: REL.2 (or PRT-4?)
rim: .functionCode

0..0

There are no (further) constraints on this element

Element id

Patient.contained.participant.role.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.contained.participant.role.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

coding

0..*

There are no (further) constraints on this element

Element id

Patient.contained.participant.role.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Data type

Constraints

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

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

Patient.contained.participant.role.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.contained.participant.role.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

system

0..0

There are no (further) constraints on this element

Element id

Patient.contained.participant.role.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

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

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

Patient.contained.participant.role.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

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

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.contained.participant.role.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

http://hl7.org/fhir/CodeSystem/participant-role (required)

Binding

Code

Constraints

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

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

stringBinding

There are no (further) constraints on this element

Element id

Patient.contained.participant.role.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

http://hl7.org/fhir/CodeSystem/participant-role (required)

Binding

Display

Constraints

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

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

Patient.contained.participant.role.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Constraints

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

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element id

Patient.contained.participant.role.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

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

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

member

0..1

There are no (further) constraints on this element

Element id

Patient.contained.participant.member

Short description

Who is involved

Definition

The specific person or organization who is participating/expected to participate in the care team.

Comments

Patient only needs to be listed if they have a role other than "subject of care".

Member is optional because some participants may be known only by their role, particularly in draft plans.

Data type

Constraints

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

Mappings

w5: FiveWs.actor
v2: REL.5 (or PRT-5 : ( PRV-4 {provider participations} ) / PRT-5 : ( PRV-4 {non-provider person participations} ) / PRT-5 : ( PRV-4 = (patient non-subject of care) ) / PRT-8?)
rim: .role

0..0

There are no (further) constraints on this element

Element id

Patient.contained.participant.member.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.contained.participant.member.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.contained.participant.member.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

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

Mappings

rim: N/A

type

0..1

uriBindingFixed Value

There are no (further) constraints on this element

Element id

Patient.contained.participant.member.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

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.

Comments

Data type

Binding

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

Constraints

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

Fixed value

Patient

Mappings

rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

Patient.contained.participant.member.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data type

Constraints

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

Mappings

rim: .identifier

display

0..1

There are no (further) constraints on this element

Element id

Patient.contained.participant.member.display

Short description

Text alternative for the resource

Definition

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

Comments

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.

Data type

Constraints

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

Mappings

rim: N/A

onBehalfOf

0..1

There are no (further) constraints on this element

Element id

Patient.contained.participant.onBehalfOf

Short description

Referencia a la unidad organizativa

Definition

Referencia a la unidad organizativa en el caso de estar asignando un equipo de seguimiento.

Requirements

Practitioners can be associated with multiple organizations. This element indicates which organization they were acting on behalf of.

Data type

Constraints

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

0..0

There are no (further) constraints on this element

Element id

Patient.contained.participant.onBehalfOf.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.contained.participant.onBehalfOf.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.contained.participant.onBehalfOf.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

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

Mappings

rim: N/A

type

0..1

uriBindingFixed Value

There are no (further) constraints on this element

Element id

Patient.contained.participant.onBehalfOf.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

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.

Comments

Data type

Binding

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

Constraints

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

Fixed value

Organization

Mappings

rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

Patient.contained.participant.onBehalfOf.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data type

Constraints

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

Mappings

rim: .identifier

display

0..1

There are no (further) constraints on this element

Element id

Patient.contained.participant.onBehalfOf.display

Short description

Text alternative for the resource

Definition

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

Comments

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.

Data type

Constraints

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

Mappings

rim: N/A

period

0..1

There are no (further) constraints on this element

Element id

Patient.contained.participant.period

Short description

Time period of participant

Definition

Indicates when the specific member or organization did (or is intended to) come into effect and end.

Data type

Constraints

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

reasonCode

0..0

There are no (further) constraints on this element

Element id

Patient.contained.reasonCode

Short description

Why the care team exists

Definition

Describes why the care team exists.

Data type

SNOMEDCTClinicalFindings (example)

Binding

Indicates the reason for the care team.

Constraints

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

Mappings

w5: FiveWs.why[x]

reasonReference

0..0

Reference(Condition)

There are no (further) constraints on this element

Element id

Patient.contained.reasonReference

Short description

Why the care team exists

Definition

Condition(s) that this care team addresses.

Data type

Reference(Condition)

Constraints

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

Mappings

w5: FiveWs.why[x]

managingOrganization

0..0

There are no (further) constraints on this element

Element id

Patient.contained.managingOrganization

Short description

Organization responsible for the care team

Definition

The organization responsible for the care team.

Requirements

Allows for multiple organizations to collaboratively manage cross-organizational, longitudinal care plan.

Data type

Constraints

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

telecom

0..0

There are no (further) constraints on this element

Element id

Patient.contained.telecom

Short description

A contact detail for the care team (that applies to all members)

Definition

A central contact detail for the care team (that applies to all members).

Comments

The ContactPoint.use code of home is not appropriate to use. These contacts are not the contact details of individual care team members.

Data type

Constraints

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

note

0..0

Annotation

There are no (further) constraints on this element

Element id

Patient.contained.note

Short description

Comments made about the CareTeam

Definition

Comments made about the CareTeam.

Data type

Annotation

Constraints

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

extension

0..*

Element id

Patient.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Constraints

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

Mappings

rim: N/A

patientBirthcountry

0..*

Element id

Patient.extension:patientBirthcountry

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/patient-birthcountry

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

patientConfidential

0..*

Element id

Patient.extension:patientConfidential

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/patient-confidential

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

patientIncompleteData

0..*

Element id

Patient.extension:patientIncompleteData

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/patient-incomplete-data

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

notificacionesPUSH

0..*

Element id

Patient.extension:notificacionesPUSH

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

uri:hn:additional-data:notificacionesPUSH

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

notificacionesSMS

0..*

Element id

Patient.extension:notificacionesSMS

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

https://example.org/fhir/StructureDefinition/NotificacionesSMS

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

notificacioneseMail

0..*

Element id

Patient.extension:notificacioneseMail

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

uri:hn:additional-data:notificacionesEmail

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

patientCareteam

0..*

Extension(Complex)

Element id

Patient.extension:patientCareteam

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Complex)

Extension URL

http://hn.indra.es/fhir/StructureDefinition/patient-careteam

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

0..0

There are no (further) constraints on this element

Element id

Patient.extension:patientCareteam.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.extension:patientCareteam.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Patient.extension:patientCareteam.url

Short description

identifies the meaning of the extension

Definition

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

Comments

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.

Data type

Fixed value

http://hn.indra.es/fhir/StructureDefinition/patient-careteam

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Patient.extension:patientCareteam.value[x]

Short description

Value of extension

Definition

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

Constraints

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

Mappings

rim: N/A

0..0

There are no (further) constraints on this element

Element id

Patient.extension:patientCareteam.value[x].id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.extension:patientCareteam.value[x].extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

reference

Σ C

0..1

Element id

Patient.extension:patientCareteam.value[x].reference

Short description

Referencia a cada uno de los careteam

Definition

Referencia a cada uno de los careteam

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

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

Mappings

rim: N/A

type

0..0

uriBinding

There are no (further) constraints on this element

Element id

Patient.extension:patientCareteam.value[x].type

Short description

Type the reference refers to (e.g. "Patient")

Definition

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.

Comments

Data type

Binding

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

Constraints

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

Mappings

rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

Patient.extension:patientCareteam.value[x].identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data type

Constraints

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

Mappings

rim: .identifier

display

0..0

There are no (further) constraints on this element

Element id

Patient.extension:patientCareteam.value[x].display

Short description

Text alternative for the resource

Definition

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

Comments

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.

Data type

Constraints

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

Mappings

rim: N/A

valueReference

Reference()

Data type

Reference()

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Patient.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

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

Requirements

Comments

Data type

Constraints

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

Mappings

rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

Patient.identifier

Short description

An identifier for this patient

Definition

An identifier for this patient.

Requirements

Patients are almost always assigned specific numerical identifiers.

Data type

Constraints

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

Mappings

w5: FiveWs.identifier
v2: PID-3
rim: id
cda: .id

0..0

There are no (further) constraints on this element

Element id

Patient.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

Element id

Patient.identifier.extension

Short description

Extensión Tutor

Alternate names

extensions, user content

Definition

Extensión que indica si este paciente está tutetado por otro paciente con el identificador contenido.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

identifierGuardian

0..*

Element id

Patient.identifier.extension:identifierGuardian

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/identifier-guardian

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

Patient.identifier.extension:identifierGuardian.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.identifier.extension:identifierGuardian.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Patient.identifier.extension:identifierGuardian.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

Fixed value

http://hn.indra.es/fhir/StructureDefinition/identifier-guardian

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Patient.identifier.extension:identifierGuardian.value[x]

Short description

Value of extension

Definition

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

Constraints

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

Mappings

rim: N/A

valueBoolean

There are no (further) constraints on this element

Data type

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Patient.identifier.type

Short description

Description of identifier

Definition

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

Requirements

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

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.

Data type

Binding

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

Constraints

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

Mappings

v2: CX.5
rim: Role.code or implied by context

0..0

There are no (further) constraints on this element

Element id

Patient.identifier.type.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.identifier.type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

coding

0..*

There are no (further) constraints on this element

Element id

Patient.identifier.type.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Constraints

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

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

Patient.identifier.type.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.identifier.type.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

system

0..1

There are no (further) constraints on this element

Element id

Patient.identifier.type.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

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

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

Patient.identifier.type.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

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

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..0

There are no (further) constraints on this element

Element id

Patient.identifier.type.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Constraints

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

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

Patient.identifier.type.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Constraints

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

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

Patient.identifier.type.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Constraints

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

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

Patient.identifier.type.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

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

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

system

0..1

uriBinding

Element id

Patient.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

http://hl7.org/fhir/CodeSystem/Identificador_persona (required)

Binding

OID

Constraints

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

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..1

There are no (further) constraints on this element

Element id

Patient.identifier.value

Short description

The value that is unique

Definition

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

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.

Data type

Constraints

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

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..0

There are no (further) constraints on this element

Element id

Patient.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

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

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..0

There are no (further) constraints on this element

Element id

Patient.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

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

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

active

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Patient.active

Short description

Whether this patient's record is in active use

Definition

Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

It is often used to filter patient lists to exclude inactive patients

Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

Requirements

Need to be able to mark a patient record as not to be used because it was created in error.

Comments

If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

Meaning when missing

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

Data type

Constraints

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

Mappings

w5: FiveWs.status
rim: statusCode
cda: n/a

name

0..*

There are no (further) constraints on this element

Element id

Patient.name

Short description

A name associated with the patient

Definition

A name associated with the individual.

Requirements

Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

Comments

A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

Data type

Constraints

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

Mappings

v2: PID-5, PID-9
rim: name
cda: .patient.name

0..0

There are no (further) constraints on this element

Element id

Patient.name.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.name.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

humanNameFathersFamily

0..*

Element id

Patient.name.extension:humanNameFathersFamily

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hl7.org/fhir/StructureDefinition/humanname-fathers-family

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

humanNameMothersFamily

0..*

Element id

Patient.name.extension:humanNameMothersFamily

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hl7.org/fhir/StructureDefinition/humanname-mothers-family

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.name.use

Short description

Definition

Identifies the purpose for this name.

Requirements

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

Comments

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

Data type

Binding

The use of a human name.

NameUse (required)

Constraints

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

Mappings

v2: XPN.7, but often indicated by which field contains the name
rim: unique(./use)
servd: ./NamePurpose

text

0..1

There are no (further) constraints on this element

Element id

Patient.name.text

Short description

Text representation of the full name

Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

Constraints

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

Mappings

v2: implied by XPN.11
rim: ./formatted

family

0..1

There are no (further) constraints on this element

Element id

Patient.name.family

Short description

Family name (often called 'Surname')

Alternate names

surname

Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Data type

Constraints

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

Mappings

v2: XPN.1/FN.1
rim: ./part[partType = FAM]
servd: ./FamilyName

given

0..*

There are no (further) constraints on this element

Element id

Patient.name.given

Short description

Given names (not always 'first'). Includes middle names

Alternate names

first name, middle name

Definition

Given name.

Comments

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Data type

Constraints

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

Mappings

v2: XPN.2 + XPN.3
rim: ./part[partType = GIV]
servd: ./GivenNames

prefix

0..0

There are no (further) constraints on this element

Element id

Patient.name.prefix

Short description

Parts that come before the name

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

Data type

Constraints

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

Mappings

v2: XPN.5
rim: ./part[partType = PFX]
servd: ./TitleCode

suffix

0..0

There are no (further) constraints on this element

Element id

Patient.name.suffix

Short description

Parts that come after the name

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Data type

Constraints

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

Mappings

v2: XPN/4
rim: ./part[partType = SFX]

period

0..0

There are no (further) constraints on this element

Element id

Patient.name.period

Short description

Time period when name was/is in use

Definition

Indicates the period of time when this name was valid for the named person.

Requirements

Allows names to be placed in historical context.

Data type

Constraints

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

Mappings

v2: XPN.13 + XPN.14
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

telecom

0..*

There are no (further) constraints on this element

Element id

Patient.telecom

Short description

A contact detail for the individual

Definition

A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

Requirements

People have (primary) ways to contact them in some way such as phone, email.

Comments

A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

Data type

Constraints

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

Mappings

v2: PID-13, PID-14, PID-40
rim: telecom
cda: .telecom

0..1

There are no (further) constraints on this element

Element id

Patient.telecom.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.telecom.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

telecomIdentifier

0..*

Element id

Patient.telecom.extension:telecomIdentifier

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/telecom-identifier

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

system

Σ C

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.telecom.system

Short description

phone | fax | email | pager | url | sms | other

Definition

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

Data type

Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Conditions

The cardinality or value of this element may be affected by these constraints: cpt-2

Constraints

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

Mappings

v2: XTN.3
rim: ./scheme
servd: ./ContactPointType

value

0..1

There are no (further) constraints on this element

Element id

Patient.telecom.value

Short description

The actual contact point details

Definition

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

Requirements

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

Comments

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

Data type

Constraints

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

Mappings

v2: XTN.1 (or XTN.12)
rim: ./url
servd: ./Value

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.telecom.use

Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

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

Comments

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

Data type

Binding

Use of contact point.

ContactPointUse (required)

Constraints

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

Mappings

v2: XTN.2 - but often indicated by field
rim: unique(./use)
servd: ./ContactPointPurpose

rank

0..1

There are no (further) constraints on this element

Element id

Patient.telecom.rank

Short description

Specify preferred order of use (1 = highest)

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.

Comments

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

Data type

Constraints

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

Mappings

v2: n/a
rim: n/a

period

0..1

There are no (further) constraints on this element

Element id

Patient.telecom.period

Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Data type

Constraints

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

Mappings

v2: N/A
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

gender

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.gender

Short description

male | female | other | unknown

Definition

Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

Requirements

Needed for identification of the individual, in combination with (at least) name and birth date.

Comments

The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

Data type

AdministrativeGender (required)

Binding

The gender of a person used for administrative purposes.

Constraints

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

Mappings

v2: PID-8
rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
cda: .patient.administrativeGenderCode

birthDate

0..1

There are no (further) constraints on this element

Element id

Patient.birthDate

Short description

The date of birth for the individual

Definition

The date of birth for the individual.

Requirements

Age of the individual drives many clinical processes.

Comments

At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

Data type

Constraints

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

Mappings

v2: PID-7
rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
cda: .patient.birthTime
loinc: 21112-8

deceased[x]

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Patient.deceased[x]

Short description

Indicates if the individual is deceased or not

Definition

Indicates if the individual is deceased or not.

Requirements

The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

Comments

If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

Constraints

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

Mappings

v2: PID-30 (bool) and PID-29 (datetime)
rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
cda: n/a

deceasedBoolean

There are no (further) constraints on this element

Data type

deceasedDateTime

There are no (further) constraints on this element

Data type

address

0..*

There are no (further) constraints on this element

Element id

Patient.address

Short description

An address for the individual

Definition

An address for the individual.

Requirements

May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

Comments

Patient may have multiple addresses with different uses or applicable periods.

Data type

Constraints

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

Mappings

v2: PID-11
rim: addr
cda: .addr

0..0

There are no (further) constraints on this element

Element id

Patient.address.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.address.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

tipoVia

0..*

Element id

Patient.address.extension:tipoVia

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/item/additional-data/typeStreet

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

addressContactFlag

0..*

Element id

Patient.address.extension:addressContactFlag

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/address-contact-flag

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

streetName

0..*

Element id

Patient.address.extension:streetName

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.address.use

Short description

home | work | temp | old | billing - purpose of this address

Definition

The purpose of this address.

Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Data type

Binding

The use of an address.

AddressUse (required)

Constraints

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

Examples
General

home

Mappings

v2: XAD.7
rim: unique(./use)
servd: ./AddressPurpose

type

0..1

codeBinding

There are no (further) constraints on this element

Element id

Patient.address.type

Short description

postal | physical | both

Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Data type

Binding

The type of an address (physical / postal).

AddressType (required)

Constraints

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

Examples
General

both

Mappings

v2: XAD.18
rim: unique(./use)
vcard: address type parameter

text

0..1

There are no (further) constraints on this element

Element id

Patient.address.text

Short description

Text representation of the address

Definition

Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

Constraints

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

Examples
General

137 Nowhere Street, Erewhon 9132

Mappings

v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
rim: ./formatted
vcard: address label parameter

line

0..*

There are no (further) constraints on this element

Element id

Patient.address.line

Short description

Street name, number, direction & P.O. Box etc.

Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Data type

Constraints

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

Examples
General

137 Nowhere Street

Mappings

v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
rim: AD.part[parttype = AL]
vcard: street
servd: ./StreetAddress (newline delimitted)

city

0..1

There are no (further) constraints on this element

Element id

Patient.address.city

Short description

Name of city, town etc.

Alternate names

Municpality

Definition

The name of the city, town, suburb, village or other community or delivery center.

Data type

Constraints

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

Examples
General

Erewhon

Mappings

v2: XAD.3
rim: AD.part[parttype = CTY]
vcard: locality
servd: ./Jurisdiction

district

0..0

There are no (further) constraints on this element

Element id

Patient.address.district

Short description

District name (aka county)

Alternate names

County

Definition

The name of the administrative area (county).

Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Data type

Constraints

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

Examples
General

Madison

Mappings

v2: XAD.9
rim: AD.part[parttype = CNT | CPA]

state

0..0

There are no (further) constraints on this element

Element id

Patient.address.state

Short description

Sub-unit of country (abbreviations ok)

Alternate names

Province, Territory

Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

Data type

Constraints

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

Mappings

v2: XAD.4
rim: AD.part[parttype = STA]
vcard: region
servd: ./Region

postalCode

0..1

There are no (further) constraints on this element

Element id

Patient.address.postalCode

Short description

Postal code for area

Alternate names

Zip

Definition

A postal code designating a region defined by the postal service.

Data type

Constraints

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

Examples
General

Mappings

v2: XAD.5
rim: AD.part[parttype = ZIP]
vcard: code
servd: ./PostalIdentificationCode

country

0..1

There are no (further) constraints on this element

Element id

Patient.address.country

Short description

Country (e.g. can be ISO 3166 2 or 3 letter code)

Definition

Country - a nation as commonly understood or generally accepted.

Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Data type

Constraints

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

Mappings

v2: XAD.6
rim: AD.part[parttype = CNT]
vcard: country
servd: ./Country

period

0..0

There are no (further) constraints on this element

Element id

Patient.address.period

Short description

Time period when address was/is in use

Definition

Time period when address was/is in use.

Requirements

Allows addresses to be placed in historical context.

Data type

Constraints

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

Examples
General

{
  "start": "2010-03-23",
  "end": "2010-07-01"
}

Mappings

v2: XAD.12 / XAD.13 + XAD.14
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

maritalStatus

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Patient.maritalStatus

Short description

Marital (civil) status of a patient

Definition

This field contains a patient's most recent marital (civil) status.

Requirements

Most, if not all systems capture it.

Data type

Marital Status Codes (extensible)

Binding

The domestic partnership status of a person.

Constraints

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

Mappings

v2: PID-16
rim: player[classCode=PSN]/maritalStatusCode
cda: .patient.maritalStatusCode

multipleBirth[x]

0..0

There are no (further) constraints on this element

Element id

Patient.multipleBirth[x]

Short description

Whether patient is part of a multiple birth

Definition

Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

Requirements

For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

Comments

Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

Constraints

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

Mappings

v2: PID-24 (bool), PID-25 (integer)
rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
cda: n/a

photo

0..*

There are no (further) constraints on this element

Element id

Patient.photo

Short description

Image of the patient

Definition

Image of the patient.

Requirements

Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

Comments

Guidelines:

Use id photos, not clinical photos.
Limit dimensions to thumbnail.
Keep byte count low to ease resource updates.

Data type

Constraints

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

Mappings

v2: OBX-5 - needs a profile
rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
cda: n/a

contact

0..0

There are no (further) constraints on this element

Element id

Patient.contact

Short description

A contact party (e.g. guardian, partner, friend) for the patient

Definition

A contact party (e.g. guardian, partner, friend) for the patient.

Requirements

Need to track people you can contact about the patient.

Comments

Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
pat-1: SHALL at least contain a contact's details or a reference to an organization
name.exists() or telecom.exists() or address.exists() or organization.exists()

Mappings

rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
cda: n/a

communication

0..0

There are no (further) constraints on this element

Element id

Patient.communication

Short description

A language which may be used to communicate with the patient about his or her health

Definition

A language which may be used to communicate with the patient about his or her health.

Requirements

If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

Comments

If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

Data type

Constraints

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

Mappings

rim: LanguageCommunication
cda: patient.languageCommunication

generalPractitioner

0..*

Reference(Organization | Practitioner | PractitionerRole)

There are no (further) constraints on this element

Element id

Patient.generalPractitioner

Short description

Patient's nominated primary care provider

Alternate names

careProvider

Definition

Patient's nominated care provider.

Comments

This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

Data type

Reference(Organization | Practitioner | PractitionerRole)

Constraints

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

Mappings

v2: PD1-4
rim: subjectOf.CareEvent.performer.AssignedEntity
cda: n/a

0..0

There are no (further) constraints on this element

Element id

Patient.generalPractitioner.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.generalPractitioner.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

Patient.generalPractitioner.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

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

Mappings

rim: N/A

type

0..1

uriBindingFixed Value

Element id

Patient.generalPractitioner.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

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.

Comments

Data type

Binding

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

Constraints

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

Fixed value

Practitioner

Mappings

rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

Patient.generalPractitioner.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data type

Constraints

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

Mappings

rim: .identifier

display

0..1

There are no (further) constraints on this element

Element id

Patient.generalPractitioner.display

Short description

Text alternative for the resource

Definition

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

Comments

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.

Data type

Constraints

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

Mappings

rim: N/A

managingOrganization

0..1

There are no (further) constraints on this element

Element id

Patient.managingOrganization

Short description

Organization that is the custodian of the patient record

Definition

Organization that is the custodian of the patient record.

Requirements

Need to know who recognizes this patient record, manages and updates it.

Comments

There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

Data type

Constraints

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

Mappings

rim: scoper
cda: .providerOrganization

0..0

There are no (further) constraints on this element

Element id

Patient.managingOrganization.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Patient.managingOrganization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

reference

Σ C

0..1

stringFixed Value

Element id

Patient.managingOrganization.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

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

Fixed value

MPI

Mappings

rim: N/A

type

0..0

uriBinding

There are no (further) constraints on this element

Element id

Patient.managingOrganization.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

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.

Comments

Data type

Binding

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

Constraints

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

Mappings

rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

Patient.managingOrganization.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data type

Constraints

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

Mappings

rim: .identifier

display

0..0

There are no (further) constraints on this element

Element id

Patient.managingOrganization.display

Short description

Text alternative for the resource

Definition

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

Comments

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.

Data type

Constraints

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

Mappings

rim: N/A

link

Σ ?!

0..0

There are no (further) constraints on this element

Element id

Patient.link

Short description

Link to another patient resource that concerns the same actual person

Definition

Link to another patient resource that concerns the same actual patient.

Requirements

There are multiple use cases:

Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
Distribution of patient information across multiple servers.

Comments

There is no assumption that linked patient records have mutual links.

Data type

Constraints

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

Mappings

rim: outboundLink
cda: n/a

{

"resourceType": "StructureDefinition",
"url": "https://hn.indra.es/fhir/StructureDefinition/Paciente",
"name": "Paciente",
"status": "draft",
"date": "2024-05-08T13:18:11.5981523+00:00",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Patient",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Patient.id",
"path": "Patient.id",
"short": "Identificador lógico asociado al recurso",
"definition": "Identificador lógico del recurso, usado en la URL del mismo, una vez asignado este valor nunca cambia.",
"comment": "El único momento en que un recurso no tiene id es cuando está siendo enviado al servidor usando una operación de creación."
},
{
"id": "Patient.implicitRules",
"path": "Patient.implicitRules",
"max": "0"
},
{
"id": "Patient.language",
"path": "Patient.language",
"max": "0"
},
{
"id": "Patient.text",
"path": "Patient.text",
"max": "0"
},
{
"id": "Patient.contained",
"path": "Patient.contained",
"type": [
{
"code": "Resource",
"profile": [
"https://hn.indra.es/fhir/StructureDefinition/CareTeam"
]
}
]
},
{
"id": "Patient.contained.id",
"path": "Patient.contained.id",
"short": "Identificador secuencial del careteam",
"definition": "Este identificador se tiene que corresponder con uno existente en la extensión patient-careteam del recurso paciente."
},
{
"id": "Patient.contained.implicitRules",
"path": "Patient.contained.implicitRules",
"max": "0"
},
{
"id": "Patient.contained.language",
"path": "Patient.contained.language",
"max": "0"
},
{
"id": "Patient.contained.text",
"path": "Patient.contained.text",
"max": "0"
},
{
"id": "Patient.contained.identifier",
"path": "Patient.contained.identifier",
"max": "0"
},
{
"id": "Patient.contained.name",
"path": "Patient.contained.name",
"max": "0"
},
{
"id": "Patient.extension:patientBirthcountry",
"path": "Patient.extension",
"sliceName": "patientBirthcountry",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/patient-birthcountry"
]
}
],
"isModifier": false
},
{
"id": "Patient.extension:patientConfidential",
"path": "Patient.extension",
"sliceName": "patientConfidential",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/patient-confidential"
]
}
],
"isModifier": false
},
{
"id": "Patient.extension:patientIncompleteData",
"path": "Patient.extension",
"sliceName": "patientIncompleteData",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/patient-incomplete-data"
]
}
],
"isModifier": false
},
{
"id": "Patient.extension:notificacionesPUSH",
"path": "Patient.extension",
"sliceName": "notificacionesPUSH",
"type": [
{
"code": "Extension",
"profile": [
"uri:hn:additional-data:notificacionesPUSH"
]
}
],
"isModifier": false
},
{
"id": "Patient.extension:notificacionesSMS",
"path": "Patient.extension",
"sliceName": "notificacionesSMS",
"type": [
{
"code": "Extension",
"profile": [
"https://example.org/fhir/StructureDefinition/NotificacionesSMS"
]
}
],
"isModifier": false
},
{
"id": "Patient.extension:notificacioneseMail",
"path": "Patient.extension",
"sliceName": "notificacioneseMail",
"type": [
{
"code": "Extension",
"profile": [
"uri:hn:additional-data:notificacionesEmail"
]
}
],
"isModifier": false
},
{
"id": "Patient.extension:patientCareteam",
"path": "Patient.extension",
"sliceName": "patientCareteam",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/patient-careteam"
]
}
],
"isModifier": false
},
{
"id": "Patient.extension:patientCareteam.value[x]",
"path": "Patient.extension.value[x]",
"type": [
{
"code": "Reference"
}
]
},
{
"id": "Patient.extension:patientCareteam.value[x].id",
"path": "Patient.extension.value[x].id",
"max": "0"
},
{
"id": "Patient.extension:patientCareteam.value[x].reference",
"path": "Patient.extension.value[x].reference",
"short": "Referencia a cada uno de los careteam",
"definition": "Referencia a cada uno de los careteam"
},
{
"id": "Patient.extension:patientCareteam.value[x].type",
"path": "Patient.extension.value[x].type",
"max": "0"
},
{
"id": "Patient.extension:patientCareteam.value[x].identifier",
"path": "Patient.extension.value[x].identifier",
"max": "0"
},
{
"id": "Patient.extension:patientCareteam.value[x].display",
"path": "Patient.extension.value[x].display",
"max": "0"
},
{
"id": "Patient.identifier.id",
"path": "Patient.identifier.id",
"max": "0"
},
{
"id": "Patient.identifier.extension",
"path": "Patient.identifier.extension",
"short": "Extensión Tutor",
"definition": "Extensión que indica si este paciente está tutetado por otro paciente con el identificador contenido."
},
{
"id": "Patient.identifier.extension:identifierGuardian",
"path": "Patient.identifier.extension",
"sliceName": "identifierGuardian",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/identifier-guardian"
]
}
],
"isModifier": false
},
{
"id": "Patient.identifier.extension:identifierGuardian.id",
"path": "Patient.identifier.extension.id",
"max": "0"
},
{
"id": "Patient.identifier.type.id",
"path": "Patient.identifier.type.id",
"max": "0"
},
{
"id": "Patient.identifier.type.coding.id",
"path": "Patient.identifier.type.coding.id",
"max": "0"
},
{
"id": "Patient.identifier.type.coding.version",
"path": "Patient.identifier.type.coding.version",
"max": "0"
},
{
"id": "Patient.identifier.type.coding.code",
"path": "Patient.identifier.type.coding.code",
"max": "0"
},
{
"id": "Patient.identifier.type.coding.userSelected",
"path": "Patient.identifier.type.coding.userSelected",
"max": "0"
},
{
"id": "Patient.identifier.type.text",
"path": "Patient.identifier.type.text",
"max": "0"
},
{
"id": "Patient.identifier.system",
"path": "Patient.identifier.system",
"binding": {
"strength": "required",
"description": "OID",
"valueSet": "http://hl7.org/fhir/CodeSystem/Identificador_persona"
}
},
{
"id": "Patient.identifier.period",
"path": "Patient.identifier.period",
"max": "0"
},
{
"id": "Patient.identifier.assigner",
"path": "Patient.identifier.assigner",
"max": "0"
},
{
"id": "Patient.name.id",
"path": "Patient.name.id",
"max": "0"
},
{
"id": "Patient.name.extension:humanNameFathersFamily",
"path": "Patient.name.extension",
"sliceName": "humanNameFathersFamily",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/humanname-fathers-family"
]
}
],
"isModifier": false
},
{
"id": "Patient.name.extension:humanNameMothersFamily",
"path": "Patient.name.extension",
"sliceName": "humanNameMothersFamily",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/humanname-mothers-family"
]
}
],
"isModifier": false
},
{
"id": "Patient.name.prefix",
"path": "Patient.name.prefix",
"max": "0"
},
{
"id": "Patient.name.suffix",
"path": "Patient.name.suffix",
"max": "0"
},
{
"id": "Patient.name.period",
"path": "Patient.name.period",
"max": "0"
},
{
"id": "Patient.telecom.extension:telecomIdentifier",
"path": "Patient.telecom.extension",
"sliceName": "telecomIdentifier",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/telecom-identifier"
]
}
],
"isModifier": false
},
{
"id": "Patient.address.id",
"path": "Patient.address.id",
"max": "0"
},
{
"id": "Patient.address.extension:tipoVia",
"path": "Patient.address.extension",
"sliceName": "tipoVia",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/item/additional-data/typeStreet"
]
}
],
"isModifier": false
},
{
"id": "Patient.address.extension:addressContactFlag",
"path": "Patient.address.extension",
"sliceName": "addressContactFlag",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/address-contact-flag"
]
}
],
"isModifier": false
},
{
"id": "Patient.address.extension:streetName",
"path": "Patient.address.extension",
"sliceName": "streetName",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
]
}
],
"isModifier": false
},
{
"id": "Patient.address.district",
"path": "Patient.address.district",
"max": "0"
},
{
"id": "Patient.address.state",
"path": "Patient.address.state",
"max": "0"
},
{
"id": "Patient.address.period",
"path": "Patient.address.period",
"max": "0"
},
{
"id": "Patient.maritalStatus",
"path": "Patient.maritalStatus",
"max": "0"
},
{
"id": "Patient.multipleBirth[x]",
"path": "Patient.multipleBirth[x]",
"max": "0"
},
{
"id": "Patient.contact",
"path": "Patient.contact",
"max": "0"
},
{
"id": "Patient.communication",
"path": "Patient.communication",
"max": "0"
},
{
"id": "Patient.generalPractitioner.id",
"path": "Patient.generalPractitioner.id",
"max": "0"
},
{
"id": "Patient.generalPractitioner.type",
"path": "Patient.generalPractitioner.type",
"fixedUri": "Practitioner"
},
{
"id": "Patient.generalPractitioner.identifier",
"path": "Patient.generalPractitioner.identifier",
"max": "0"
},
{
"id": "Patient.managingOrganization.id",
"path": "Patient.managingOrganization.id",
"max": "0"
},
{
"id": "Patient.managingOrganization.reference",
"path": "Patient.managingOrganization.reference",
"fixedString": "MPI"
},
{
"id": "Patient.managingOrganization.type",
"path": "Patient.managingOrganization.type",
"max": "0"
},
{
"id": "Patient.managingOrganization.identifier",
"path": "Patient.managingOrganization.identifier",
"max": "0"
},
{
"id": "Patient.managingOrganization.display",
"path": "Patient.managingOrganization.display",
"max": "0"
},
{
"id": "Patient.link",
"path": "Patient.link",
"max": "0"
}
]
}

}

<url value="https://hn.indra.es/fhir/StructureDefinition/Paciente" />
<name value="Paciente" />
<status value="draft" />
<date value="2024-05-08T13:18:11.5981523+00:00" />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Patient" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Patient" />
<derivation value="constraint" />
<differential>
<element id="Patient.id">
<path value="Patient.id" />
<short value="Identificador lógico asociado al recurso" />
<definition value="Identificador lógico del recurso, usado en la URL del mismo, una vez asignado este valor nunca cambia." />
<comment value="El único momento en que un recurso no tiene id es cuando está siendo enviado al servidor usando una operación de creación." />
</element>
<element id="Patient.implicitRules">
<path value="Patient.implicitRules" />
<max value="0" />
</element>
<element id="Patient.language">
<path value="Patient.language" />
<max value="0" />
</element>
<element id="Patient.text">
<path value="Patient.text" />
<max value="0" />
</element>
<element id="Patient.contained">
<path value="Patient.contained" />
<type>
<code value="Resource" />
<profile value="https://hn.indra.es/fhir/StructureDefinition/CareTeam" />
</type>
</element>
<element id="Patient.contained.id">
<path value="Patient.contained.id" />
<short value="Identificador secuencial del careteam" />
<definition value="Este identificador se tiene que corresponder con uno existente en la extensión patient-careteam del recurso paciente." />
</element>
<element id="Patient.contained.implicitRules">
<path value="Patient.contained.implicitRules" />
<max value="0" />
</element>
<element id="Patient.contained.language">
<path value="Patient.contained.language" />
<max value="0" />
</element>
<element id="Patient.contained.text">
<path value="Patient.contained.text" />
<max value="0" />
</element>
<element id="Patient.contained.identifier">
<path value="Patient.contained.identifier" />
<max value="0" />
</element>
<element id="Patient.contained.name">
<path value="Patient.contained.name" />
<max value="0" />
</element>
<element id="Patient.extension:patientBirthcountry">
<path value="Patient.extension" />
<sliceName value="patientBirthcountry" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/patient-birthcountry" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.extension:patientConfidential">
<path value="Patient.extension" />
<sliceName value="patientConfidential" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/patient-confidential" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.extension:patientIncompleteData">
<path value="Patient.extension" />
<sliceName value="patientIncompleteData" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/patient-incomplete-data" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.extension:notificacionesPUSH">
<path value="Patient.extension" />
<sliceName value="notificacionesPUSH" />
<type>
<code value="Extension" />
<profile value="uri:hn:additional-data:notificacionesPUSH" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.extension:notificacionesSMS">
<path value="Patient.extension" />
<sliceName value="notificacionesSMS" />
<type>
<code value="Extension" />
<profile value="https://example.org/fhir/StructureDefinition/NotificacionesSMS" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.extension:notificacioneseMail">
<path value="Patient.extension" />
<sliceName value="notificacioneseMail" />
<type>
<code value="Extension" />
<profile value="uri:hn:additional-data:notificacionesEmail" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.extension:patientCareteam">
<path value="Patient.extension" />
<sliceName value="patientCareteam" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/patient-careteam" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.extension:patientCareteam.value[x]">
<path value="Patient.extension.value[x]" />
<type>
<code value="Reference" />
</type>
</element>
<element id="Patient.extension:patientCareteam.value[x].id">
<path value="Patient.extension.value[x].id" />
<max value="0" />
</element>
<element id="Patient.extension:patientCareteam.value[x].reference">
<path value="Patient.extension.value[x].reference" />
<short value="Referencia a cada uno de los careteam" />
<definition value="Referencia a cada uno de los careteam" />
</element>
<element id="Patient.extension:patientCareteam.value[x].type">
<path value="Patient.extension.value[x].type" />
<max value="0" />
</element>
<element id="Patient.extension:patientCareteam.value[x].identifier">
<path value="Patient.extension.value[x].identifier" />
<max value="0" />
</element>
<element id="Patient.extension:patientCareteam.value[x].display">
<path value="Patient.extension.value[x].display" />
<max value="0" />
</element>
<element id="Patient.identifier.id">
<path value="Patient.identifier.id" />
<max value="0" />
</element>
<element id="Patient.identifier.extension">
<path value="Patient.identifier.extension" />
<short value="Extensión Tutor" />
<definition value="Extensión que indica si este paciente está tutetado por otro paciente con el identificador contenido." />
</element>
<element id="Patient.identifier.extension:identifierGuardian">
<path value="Patient.identifier.extension" />
<sliceName value="identifierGuardian" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/identifier-guardian" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.identifier.extension:identifierGuardian.id">
<path value="Patient.identifier.extension.id" />
<max value="0" />
</element>
<element id="Patient.identifier.type.id">
<path value="Patient.identifier.type.id" />
<max value="0" />
</element>
<element id="Patient.identifier.type.coding.id">
<path value="Patient.identifier.type.coding.id" />
<max value="0" />
</element>
<element id="Patient.identifier.type.coding.version">
<path value="Patient.identifier.type.coding.version" />
<max value="0" />
</element>
<element id="Patient.identifier.type.coding.code">
<path value="Patient.identifier.type.coding.code" />
<max value="0" />
</element>
<element id="Patient.identifier.type.coding.userSelected">
<path value="Patient.identifier.type.coding.userSelected" />
<max value="0" />
</element>
<element id="Patient.identifier.type.text">
<path value="Patient.identifier.type.text" />
<max value="0" />
</element>
<element id="Patient.identifier.system">
<path value="Patient.identifier.system" />
<binding>
<strength value="required" />
<description value="OID" />
<valueSet value="http://hl7.org/fhir/CodeSystem/Identificador_persona" />
</binding>
</element>
<element id="Patient.identifier.period">
<path value="Patient.identifier.period" />
<max value="0" />
</element>
<element id="Patient.identifier.assigner">
<path value="Patient.identifier.assigner" />
<max value="0" />
</element>
<element id="Patient.name.id">
<path value="Patient.name.id" />
<max value="0" />
</element>
<element id="Patient.name.extension:humanNameFathersFamily">
<path value="Patient.name.extension" />
<sliceName value="humanNameFathersFamily" />
<type>
<code value="Extension" />
<profile value="http://hl7.org/fhir/StructureDefinition/humanname-fathers-family" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.name.extension:humanNameMothersFamily">
<path value="Patient.name.extension" />
<sliceName value="humanNameMothersFamily" />
<type>
<code value="Extension" />
<profile value="http://hl7.org/fhir/StructureDefinition/humanname-mothers-family" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.name.prefix">
<path value="Patient.name.prefix" />
<max value="0" />
</element>
<element id="Patient.name.suffix">
<path value="Patient.name.suffix" />
<max value="0" />
</element>
<element id="Patient.name.period">
<path value="Patient.name.period" />
<max value="0" />
</element>
<element id="Patient.telecom.extension:telecomIdentifier">
<path value="Patient.telecom.extension" />
<sliceName value="telecomIdentifier" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/telecom-identifier" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.address.id">
<path value="Patient.address.id" />
<max value="0" />
</element>
<element id="Patient.address.extension:tipoVia">
<path value="Patient.address.extension" />
<sliceName value="tipoVia" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/item/additional-data/typeStreet" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.address.extension:addressContactFlag">
<path value="Patient.address.extension" />
<sliceName value="addressContactFlag" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/address-contact-flag" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.address.extension:streetName">
<path value="Patient.address.extension" />
<sliceName value="streetName" />
<type>
<code value="Extension" />
<profile value="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName" />
</type>
<isModifier value="false" />
</element>
<element id="Patient.address.district">
<path value="Patient.address.district" />
<max value="0" />
</element>
<element id="Patient.address.state">
<path value="Patient.address.state" />
<max value="0" />
</element>
<element id="Patient.address.period">
<path value="Patient.address.period" />
<max value="0" />
</element>
<element id="Patient.maritalStatus">
<path value="Patient.maritalStatus" />
<max value="0" />
</element>
<element id="Patient.multipleBirth[x]">
<path value="Patient.multipleBirth[x]" />
<max value="0" />
</element>
<element id="Patient.contact">
<path value="Patient.contact" />
<max value="0" />
</element>
<element id="Patient.communication">
<path value="Patient.communication" />
<max value="0" />
</element>
<element id="Patient.generalPractitioner.id">
<path value="Patient.generalPractitioner.id" />
<max value="0" />
</element>
<element id="Patient.generalPractitioner.type">
<path value="Patient.generalPractitioner.type" />
<fixedUri value="Practitioner" />
</element>
<element id="Patient.generalPractitioner.identifier">
<path value="Patient.generalPractitioner.identifier" />
<max value="0" />
</element>
<element id="Patient.managingOrganization.id">
<path value="Patient.managingOrganization.id" />
<max value="0" />
</element>
<element id="Patient.managingOrganization.reference">
<path value="Patient.managingOrganization.reference" />
<fixedString value="MPI" />
</element>
<element id="Patient.managingOrganization.type">
<path value="Patient.managingOrganization.type" />
<max value="0" />
</element>
<element id="Patient.managingOrganization.identifier">
<path value="Patient.managingOrganization.identifier" />
<max value="0" />
</element>
<element id="Patient.managingOrganization.display">
<path value="Patient.managingOrganization.display" />
<max value="0" />
</element>
<element id="Patient.link">
<path value="Patient.link" />
<max value="0" />
</element>
</differential>

</StructureDefinition>

Practitioner

Descripción del recurso Practitioner

Esta especificación describe la representación FHIR del recurso Practitioner, núcleo del módulo Resources. En esta implementación MPI ejerce como esclavo de JARA que gestiona los pacientes existentes. Los recursos practitioner se reciben vía interoperabilidad.

Practitioner

Practitioner

There are no (further) constraints on this element

Element id

Practitioner

Short description

A person with a formal responsibility in the provisioning of healthcare or related services

Definition

A person who is directly or indirectly involved in the provisioning of healthcare.

Data type

Practitioner

Constraints

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

Mappings

rim: Entity. Role, or Act
v2: PRD (as one example)
rim: Role
servd: Provider

0..1

Element id

Practitioner.id

Short description

Identificador lógico asociado al practitioner

Definition

Identificador lógico del recurso, usado en la URL del mismo, una vez asignado este valor nunca cambia.

Comments

El único momento en que un recurso no tiene id es cuando está siendo enviado al servidor usando una operación de creación.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Practitioner.meta

Short description

Metadata about the resource

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.

Data type

Constraints

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

implicitRules

Σ ?!

0..0

There are no (further) constraints on this element

Element id

Practitioner.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

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

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Practitioner.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

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

text

0..0

There are no (further) constraints on this element

Element id

Practitioner.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

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

Mappings

rim: Act.text?

contained

0..0

There are no (further) constraints on this element

Element id

Practitioner.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

0..*

Element id

Practitioner.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Constraints

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

Mappings

rim: N/A

practitionerImplant

0..*

Element id

Practitioner.extension:practitionerImplant

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/practitioner-implant

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

practitionerLogin

0..*

Element id

Practitioner.extension:practitionerLogin

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/practitioner-login

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

practitionerNumber

0..*

Element id

Practitioner.extension:practitionerNumber

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/practitioner-number

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

practitionerValidDateFrom

0..*

Extension(date)

Element id

Practitioner.extension:practitionerValidDateFrom

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(date)

Extension URL

http://hn.indra.es/fhir/StructureDefinition/practitioner-valid-date-from

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Practitioner.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

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

Requirements

Comments

Data type

Constraints

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

Mappings

rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

Practitioner.identifier

Short description

An identifier for the person as this agent

Definition

An identifier that applies to this person in this role.

Requirements

Often, specific identities are assigned for the agent.

Data type

Constraints

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

Mappings

w5: FiveWs.identifier
v2: PRD-7 (or XCN.1)
rim: ./id
servd: ./Identifiers

0..0

There are no (further) constraints on this element

Element id

Practitioner.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Practitioner.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Practitioner.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Practitioner.identifier.type

Short description

Description of identifier

Definition

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

Requirements

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

Comments

Data type

Binding

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

Constraints

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

Mappings

v2: CX.5
rim: Role.code or implied by context

0..0

There are no (further) constraints on this element

Element id

Practitioner.identifier.type.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Practitioner.identifier.type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

coding

0..*

There are no (further) constraints on this element

Element id

Practitioner.identifier.type.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Constraints

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

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

Practitioner.identifier.type.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Practitioner.identifier.type.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

system

0..1

uriBinding

Element id

Practitioner.identifier.type.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Binding

System

v2.0203 (required)

Constraints

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

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

Practitioner.identifier.type.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

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

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

codeBinding

Element id

Practitioner.identifier.type.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Binding

Code

v2.0203 (required)

Constraints

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

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..0

There are no (further) constraints on this element

Element id

Practitioner.identifier.type.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Constraints

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

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

Practitioner.identifier.type.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Constraints

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

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

stringBinding

Element id

Practitioner.identifier.type.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Binding

Display

v2.0203 (required)

Constraints

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

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

system

0..1

There are no (further) constraints on this element

Element id

Practitioner.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

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

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..1

There are no (further) constraints on this element

Element id

Practitioner.identifier.value

Short description

The value that is unique

Definition

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

Comments

Data type

Constraints

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

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..1

There are no (further) constraints on this element

Element id

Practitioner.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

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

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Practitioner.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

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

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

active

0..1

There are no (further) constraints on this element

Element id

Practitioner.active

Short description

Whether this practitioner's record is in active use

Definition

Whether this practitioner's record is in active use.

Requirements

Need to be able to mark a practitioner record as not to be used because it was created in error.

Comments

If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.

Meaning when missing

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

Data type

Constraints

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

Mappings

w5: FiveWs.status
rim: ./statusCode

name

0..*

There are no (further) constraints on this element

Element id

Practitioner.name

Short description

The name(s) associated with the practitioner

Definition

The name(s) associated with the practitioner.

Requirements

The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.

Comments

The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate.

In general, select the value to be used in the ResourceReference.display based on this:

There is more than 1 name
Use = usual
Period is current to the date of the usage
Use = official
Other order as decided by internal business rules.

Data type

Constraints

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

Mappings

v2: XCN Components
rim: ./name
servd: ./PreferredName (GivenNames, FamilyName, TitleCode)

0..0

There are no (further) constraints on this element

Element id

Practitioner.name.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Practitioner.name.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

humanNameFathersFamily

0..*

Element id

Practitioner.name.extension:humanNameFathersFamily

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hl7.org/fhir/StructureDefinition/humanname-fathers-family

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Practitioner.name.use

Short description

Definition

Identifies the purpose for this name.

Requirements

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

Comments

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

Data type

Binding

The use of a human name.

NameUse (required)

Constraints

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

Mappings

v2: XPN.7, but often indicated by which field contains the name
rim: unique(./use)
servd: ./NamePurpose

text

0..1

There are no (further) constraints on this element

Element id

Practitioner.name.text

Short description

Text representation of the full name

Definition

Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Data type

Constraints

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

Mappings

v2: implied by XPN.11
rim: ./formatted

family

0..0

There are no (further) constraints on this element

Element id

Practitioner.name.family

Short description

Family name (often called 'Surname')

Alternate names

surname

Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Data type

Constraints

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

Mappings

v2: XPN.1/FN.1
rim: ./part[partType = FAM]
servd: ./FamilyName

given

0..*

There are no (further) constraints on this element

Element id

Practitioner.name.given

Short description

Given names (not always 'first'). Includes middle names

Alternate names

first name, middle name

Definition

Given name.

Comments

Data type

Constraints

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

Mappings

v2: XPN.2 + XPN.3
rim: ./part[partType = GIV]
servd: ./GivenNames

prefix

0..0

There are no (further) constraints on this element

Element id

Practitioner.name.prefix

Short description

Parts that come before the name

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

Data type

Constraints

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

Mappings

v2: XPN.5
rim: ./part[partType = PFX]
servd: ./TitleCode

suffix

0..0

There are no (further) constraints on this element

Element id

Practitioner.name.suffix

Short description

Parts that come after the name

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Data type

Constraints

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

Mappings

v2: XPN/4
rim: ./part[partType = SFX]

period

0..0

There are no (further) constraints on this element

Element id

Practitioner.name.period

Short description

Time period when name was/is in use

Definition

Indicates the period of time when this name was valid for the named person.

Requirements

Allows names to be placed in historical context.

Data type

Constraints

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

Mappings

v2: XPN.13 + XPN.14
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

telecom

0..*

There are no (further) constraints on this element

Element id

Practitioner.telecom

Short description

A contact detail for the practitioner (that apply to all roles)

Definition

A contact detail for the practitioner, e.g. a telephone number or an email address.

Requirements

Need to know how to reach a practitioner independent to any roles the practitioner may have.

Comments

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.

Data type

Constraints

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

Mappings

v2: PRT-15, STF-10, ROL-12
rim: ./telecom
servd: ./ContactPoints

0..0

There are no (further) constraints on this element

Element id

Practitioner.telecom.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Practitioner.telecom.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

system

Σ C

0..1

codeBinding

There are no (further) constraints on this element

Element id

Practitioner.telecom.system

Short description

phone | fax | email | pager | url | sms | other

Definition

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

Data type

Binding

Telecommunications form for contact point.

ContactPointSystem (required)

Conditions

The cardinality or value of this element may be affected by these constraints: cpt-2

Constraints

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

Mappings

v2: XTN.3
rim: ./scheme
servd: ./ContactPointType

value

0..1

There are no (further) constraints on this element

Element id

Practitioner.telecom.value

Short description

The actual contact point details

Definition

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

Requirements

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

Comments

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

Data type

Constraints

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

Mappings

v2: XTN.1 (or XTN.12)
rim: ./url
servd: ./Value

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Practitioner.telecom.use

Short description

home | work | temp | old | mobile - purpose of this contact point

Definition

Identifies the purpose for the contact point.

Requirements

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

Comments

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

Data type

Binding

Use of contact point.

ContactPointUse (required)

Constraints

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

Mappings

v2: XTN.2 - but often indicated by field
rim: unique(./use)
servd: ./ContactPointPurpose

rank

0..1

There are no (further) constraints on this element

Element id

Practitioner.telecom.rank

Short description

Specify preferred order of use (1 = highest)

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.

Comments

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

Data type

Constraints

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

Mappings

v2: n/a
rim: n/a

period

0..0

There are no (further) constraints on this element

Element id

Practitioner.telecom.period

Short description

Time period when the contact point was/is in use

Definition

Time period when the contact point was/is in use.

Data type

Constraints

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

Mappings

v2: N/A
rim: ./usablePeriod[type="IVL<TS>"]
servd: ./StartDate and ./EndDate

address

0..0

There are no (further) constraints on this element

Element id

Practitioner.address

Short description

Address(es) of the practitioner that are not role specific (typically home address)

Definition

Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.

Requirements

The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.

Comments

The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).

Data type

Constraints

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

Mappings

v2: ORC-24, STF-11, ROL-11, PRT-14
rim: ./addr
servd: ./Addresses

gender

0..1

codeBinding

There are no (further) constraints on this element

Element id

Practitioner.gender

Short description

male | female | other | unknown

Definition

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

Requirements

Needed to address the person correctly.

Data type

AdministrativeGender (required)

Binding

The gender of a person used for administrative purposes.

Constraints

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

Mappings

v2: STF-5
rim: ./administrativeGender
servd: ./GenderCode

birthDate

0..1

There are no (further) constraints on this element

Element id

Practitioner.birthDate

Short description

The date on which the practitioner was born

Definition

The date of birth for the practitioner.

Requirements

Needed for identification.

Data type

Constraints

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

Mappings

v2: STF-6
rim: ./birthTime
servd: (not represented in ServD)

photo

0..0

There are no (further) constraints on this element

Element id

Practitioner.photo

Short description

Image of the person

Definition

Image of the person.

Requirements

Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.

Data type

Constraints

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

Mappings

rim: ./subjectOf/ObservationEvent[code="photo"]/value
servd: ./ImageURI (only supports the URI reference)

qualification

0..0

There are no (further) constraints on this element

Element id

Practitioner.qualification

Short description

Certification, licenses, or training pertaining to the provision of care

Definition

The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.

Data type

Constraints

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

Mappings

v2: CER?
rim: .playingEntity.playingRole[classCode=QUAL].code
servd: ./Qualifications

communication

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Practitioner.communication

Short description

A language the practitioner can use in patient communication

Definition

A language the practitioner can use in patient communication.

Requirements

Knowing which language a practitioner speaks can help in facilitating communication with patients.

Comments

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

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

Mappings

v2: PID-15, NK1-20, LAN-2
rim: ./languageCommunication
servd: ./Languages.LanguageSpokenCode

{

"resourceType": "StructureDefinition",
"url": "https://hn.indra.es/fhir/StructureDefinition/Practitioner",
"name": "Practitioner",
"status": "draft",
"date": "2024-05-08T10:52:16.9356842+00:00",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Practitioner",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Practitioner",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Practitioner.id",
"path": "Practitioner.id",
"short": "Identificador lógico asociado al practitioner",
"definition": "Identificador lógico del recurso, usado en la URL del mismo, una vez asignado este valor nunca cambia.",
"comment": "El único momento en que un recurso no tiene id es cuando está siendo enviado al servidor usando una operación de creación."
},
{
"id": "Practitioner.implicitRules",
"path": "Practitioner.implicitRules",
"max": "0"
},
{
"id": "Practitioner.language",
"path": "Practitioner.language",
"max": "0"
},
{
"id": "Practitioner.text",
"path": "Practitioner.text",
"max": "0"
},
{
"id": "Practitioner.contained",
"path": "Practitioner.contained",
"max": "0"
},
{
"id": "Practitioner.extension:practitionerImplant",
"path": "Practitioner.extension",
"sliceName": "practitionerImplant",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/practitioner-implant"
]
}
],
"isModifier": false
},
{
"id": "Practitioner.extension:practitionerLogin",
"path": "Practitioner.extension",
"sliceName": "practitionerLogin",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/practitioner-login"
]
}
],
"isModifier": false
},
{
"id": "Practitioner.extension:practitionerNumber",
"path": "Practitioner.extension",
"sliceName": "practitionerNumber",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/practitioner-number"
]
}
],
"isModifier": false
},
{
"id": "Practitioner.extension:practitionerValidDateFrom",
"path": "Practitioner.extension",
"sliceName": "practitionerValidDateFrom",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/practitioner-valid-date-from"
]
}
],
"isModifier": false
},
{
"id": "Practitioner.identifier.id",
"path": "Practitioner.identifier.id",
"max": "0"
},
{
"id": "Practitioner.identifier.type.id",
"path": "Practitioner.identifier.type.id",
"max": "0"
},
{
"id": "Practitioner.identifier.type.coding.id",
"path": "Practitioner.identifier.type.coding.id",
"max": "0"
},
{
"id": "Practitioner.identifier.type.coding.system",
"path": "Practitioner.identifier.type.coding.system",
"binding": {
"strength": "required",
"description": "System",
"valueSet": "http://terminology.hl7.org/CodeSystem/v2-0203"
}
},
{
"id": "Practitioner.identifier.type.coding.version",
"path": "Practitioner.identifier.type.coding.version",
"max": "0"
},
{
"id": "Practitioner.identifier.type.coding.code",
"path": "Practitioner.identifier.type.coding.code",
"binding": {
"strength": "required",
"description": "Code",
"valueSet": "http://terminology.hl7.org/CodeSystem/v2-0203"
}
},
{
"id": "Practitioner.identifier.type.coding.display",
"path": "Practitioner.identifier.type.coding.display",
"max": "0"
},
{
"id": "Practitioner.identifier.type.coding.userSelected",
"path": "Practitioner.identifier.type.coding.userSelected",
"max": "0"
},
{
"id": "Practitioner.identifier.type.text",
"path": "Practitioner.identifier.type.text",
"binding": {
"strength": "required",
"description": "Display",
"valueSet": "http://terminology.hl7.org/CodeSystem/v2-0203"
}
},
{
"id": "Practitioner.name.id",
"path": "Practitioner.name.id",
"max": "0"
},
{
"id": "Practitioner.name.extension:humanNameFathersFamily",
"path": "Practitioner.name.extension",
"sliceName": "humanNameFathersFamily",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/humanname-fathers-family"
]
}
],
"isModifier": false
},
{
"id": "Practitioner.name.family",
"path": "Practitioner.name.family",
"max": "0"
},
{
"id": "Practitioner.name.prefix",
"path": "Practitioner.name.prefix",
"max": "0"
},
{
"id": "Practitioner.name.suffix",
"path": "Practitioner.name.suffix",
"max": "0"
},
{
"id": "Practitioner.name.period",
"path": "Practitioner.name.period",
"max": "0"
},
{
"id": "Practitioner.telecom.id",
"path": "Practitioner.telecom.id",
"max": "0"
},
{
"id": "Practitioner.telecom.period",
"path": "Practitioner.telecom.period",
"max": "0"
},
{
"id": "Practitioner.address",
"path": "Practitioner.address",
"max": "0"
},
{
"id": "Practitioner.photo",
"path": "Practitioner.photo",
"max": "0"
},
{
"id": "Practitioner.qualification",
"path": "Practitioner.qualification",
"max": "0"
},
{
"id": "Practitioner.communication",
"path": "Practitioner.communication",
"max": "0"
}
]
}

}

<url value="https://hn.indra.es/fhir/StructureDefinition/Practitioner" />
<name value="Practitioner" />
<status value="draft" />
<date value="2024-05-08T10:52:16.9356842+00:00" />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Practitioner" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
<derivation value="constraint" />
<differential>
<element id="Practitioner.id">
<path value="Practitioner.id" />
<short value="Identificador lógico asociado al practitioner" />
<definition value="Identificador lógico del recurso, usado en la URL del mismo, una vez asignado este valor nunca cambia." />
<comment value="El único momento en que un recurso no tiene id es cuando está siendo enviado al servidor usando una operación de creación." />
</element>
<element id="Practitioner.implicitRules">
<path value="Practitioner.implicitRules" />
<max value="0" />
</element>
<element id="Practitioner.language">
<path value="Practitioner.language" />
<max value="0" />
</element>
<element id="Practitioner.text">
<path value="Practitioner.text" />
<max value="0" />
</element>
<element id="Practitioner.contained">
<path value="Practitioner.contained" />
<max value="0" />
</element>
<element id="Practitioner.extension:practitionerImplant">
<path value="Practitioner.extension" />
<sliceName value="practitionerImplant" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/practitioner-implant" />
</type>
<isModifier value="false" />
</element>
<element id="Practitioner.extension:practitionerLogin">
<path value="Practitioner.extension" />
<sliceName value="practitionerLogin" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/practitioner-login" />
</type>
<isModifier value="false" />
</element>
<element id="Practitioner.extension:practitionerNumber">
<path value="Practitioner.extension" />
<sliceName value="practitionerNumber" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/practitioner-number" />
</type>
<isModifier value="false" />
</element>
<element id="Practitioner.extension:practitionerValidDateFrom">
<path value="Practitioner.extension" />
<sliceName value="practitionerValidDateFrom" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/practitioner-valid-date-from" />
</type>
<isModifier value="false" />
</element>
<element id="Practitioner.identifier.id">
<path value="Practitioner.identifier.id" />
<max value="0" />
</element>
<element id="Practitioner.identifier.type.id">
<path value="Practitioner.identifier.type.id" />
<max value="0" />
</element>
<element id="Practitioner.identifier.type.coding.id">
<path value="Practitioner.identifier.type.coding.id" />
<max value="0" />
</element>
<element id="Practitioner.identifier.type.coding.system">
<path value="Practitioner.identifier.type.coding.system" />
<binding>
<strength value="required" />
<description value="System" />
<valueSet value="http://terminology.hl7.org/CodeSystem/v2-0203" />
</binding>
</element>
<element id="Practitioner.identifier.type.coding.version">
<path value="Practitioner.identifier.type.coding.version" />
<max value="0" />
</element>
<element id="Practitioner.identifier.type.coding.code">
<path value="Practitioner.identifier.type.coding.code" />
<binding>
<strength value="required" />
<description value="Code" />
<valueSet value="http://terminology.hl7.org/CodeSystem/v2-0203" />
</binding>
</element>
<element id="Practitioner.identifier.type.coding.display">
<path value="Practitioner.identifier.type.coding.display" />
<max value="0" />
</element>
<element id="Practitioner.identifier.type.coding.userSelected">
<path value="Practitioner.identifier.type.coding.userSelected" />
<max value="0" />
</element>
<element id="Practitioner.identifier.type.text">
<path value="Practitioner.identifier.type.text" />
<binding>
<strength value="required" />
<description value="Display" />
<valueSet value="http://terminology.hl7.org/CodeSystem/v2-0203" />
</binding>
</element>
<element id="Practitioner.name.id">
<path value="Practitioner.name.id" />
<max value="0" />
</element>
<element id="Practitioner.name.extension:humanNameFathersFamily">
<path value="Practitioner.name.extension" />
<sliceName value="humanNameFathersFamily" />
<type>
<code value="Extension" />
<profile value="http://hl7.org/fhir/StructureDefinition/humanname-fathers-family" />
</type>
<isModifier value="false" />
</element>
<element id="Practitioner.name.family">
<path value="Practitioner.name.family" />
<max value="0" />
</element>
<element id="Practitioner.name.prefix">
<path value="Practitioner.name.prefix" />
<max value="0" />
</element>
<element id="Practitioner.name.suffix">
<path value="Practitioner.name.suffix" />
<max value="0" />
</element>
<element id="Practitioner.name.period">
<path value="Practitioner.name.period" />
<max value="0" />
</element>
<element id="Practitioner.telecom.id">
<path value="Practitioner.telecom.id" />
<max value="0" />
</element>
<element id="Practitioner.telecom.period">
<path value="Practitioner.telecom.period" />
<max value="0" />
</element>
<element id="Practitioner.address">
<path value="Practitioner.address" />
<max value="0" />
</element>
<element id="Practitioner.photo">
<path value="Practitioner.photo" />
<max value="0" />
</element>
<element id="Practitioner.qualification">
<path value="Practitioner.qualification" />
<max value="0" />
</element>
<element id="Practitioner.communication">
<path value="Practitioner.communication" />
<max value="0" />
</element>
</differential>

</StructureDefinition>

Organization

Descripción del recurso Organization

Esta especificación describe la representación FHIR del recurso Organization que refleja la Estructura Funcional de la Organización. Los recursos Organization se reciben vía interoperabilidad.

Organization

Organization

There are no (further) constraints on this element

Element id

Organization

Short description

A grouping of people or organizations with a common purpose

Definition

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

Data type

Organization

Constraints

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()
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
(identifier.count() + name.count()) > 0

Mappings

rim: Entity. Role, or Act
v2: (also see master files messages)
rim: Organization(classCode=ORG, determinerCode=INST)
servd: Organization

0..1

Element id

Organization.id

Short description

Identificador lógico asociado al recurso

Definition

Identificador lógico del recurso, usado en la URL del mismo, una vez asignado este valor nunca cambia.

Comments

El único momento en que un recurso no tiene id es cuando está siendo enviado al servidor usando una operación de creación.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

Organization.meta

Short description

Metadata about the resource

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.

Data type

Constraints

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

implicitRules

Σ ?!

0..0

There are no (further) constraints on this element

Element id

Organization.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

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

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

Organization.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

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

text

0..0

There are no (further) constraints on this element

Element id

Organization.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

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

Mappings

rim: Act.text?

contained

0..0

There are no (further) constraints on this element

Element id

Organization.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

0..*

Element id

Organization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Constraints

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

Mappings

rim: N/A

organizationAlias

0..*

Element id

Organization.extension:organizationAlias

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/organization-alias

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

organizationCareLine

0..*

Element id

Organization.extension:organizationCareLine

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/hncat/fhir/Organization/care_line

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

organizationCenterCode

0..*

Element id

Organization.extension:organizationCenterCode

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/center-code

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

organizationDesc

0..*

Element id

Organization.extension:organizationDesc

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/desc-desc

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

organizationParent

0..*

Element id

Organization.extension:organizationParent

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/Organization/parent-organization

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

organizationSpeciality

0..*

Element id

Organization.extension:organizationSpeciality

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/hncat/fhir/ValueSet/speciality

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

organizationSubType

0..*

Extension(Coding)

Element id

Organization.extension:organizationSubType

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

Extension(Coding)

Extension URL

http://hn.indra.es/hncat/fhir/ValueSet/organization_subtype

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Organization.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

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

Requirements

Comments

Data type

Constraints

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

Mappings

rim: N/A

identifier

Σ C

0..*

There are no (further) constraints on this element

Element id

Organization.identifier

Short description

Identifies this organization across multiple systems

Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

Requirements

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: org-1

Constraints

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

Mappings

w5: FiveWs.identifier
v2: XON.10 / XON.3
rim: .scopes[Role](classCode=IDENT)
servd: ./Identifiers

0..0

There are no (further) constraints on this element

Element id

Organization.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Organization.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Organization.identifier.type

Short description

Description of identifier

Definition

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

Requirements

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

Comments

Data type

Binding

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

Constraints

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

Mappings

v2: CX.5
rim: Role.code or implied by context

0..0

There are no (further) constraints on this element

Element id

Organization.identifier.type.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.identifier.type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

coding

0..*

There are no (further) constraints on this element

Element id

Organization.identifier.type.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Constraints

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

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

Organization.identifier.type.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.identifier.type.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

system

0..0

There are no (further) constraints on this element

Element id

Organization.identifier.type.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

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

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

Organization.identifier.type.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

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

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element id

Organization.identifier.type.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

Constraints

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

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..0

There are no (further) constraints on this element

Element id

Organization.identifier.type.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Constraints

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

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

Organization.identifier.type.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Constraints

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

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

Organization.identifier.type.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

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

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

system

0..0

There are no (further) constraints on this element

Element id

Organization.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

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

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..1

There are no (further) constraints on this element

Element id

Organization.identifier.value

Short description

The value that is unique

Definition

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

Comments

Data type

Constraints

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

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..0

There are no (further) constraints on this element

Element id

Organization.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

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

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..0

There are no (further) constraints on this element

Element id

Organization.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

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

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

active

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Organization.active

Short description

Whether the organization's record is still in active use

Definition

Whether the organization's record is still in active use.

Requirements

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Comments

This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

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

Data type

Constraints

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

Mappings

w5: FiveWs.status
v2: No equivalent in HL7 v2
rim: .status
servd: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.

type

0..*

There are no (further) constraints on this element

Element id

Organization.type

Short description

Kind of organization

Definition

The kind(s) of organization that this is.

Requirements

Need to be able to track the kind of organization that this is - different organization types have different uses.

Comments

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

Data type

Binding

Used to categorize the organization.

OrganizationType (example)

Constraints

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

Mappings

w5: FiveWs.class
v2: No equivalent in v2
rim: .code
servd: n/a

0..0

There are no (further) constraints on this element

Element id

Organization.type.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

coding

0..*

There are no (further) constraints on this element

Element id

Organization.type.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Constraints

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

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

Organization.type.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.type.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

system

0..1

uriFixed Value

Element id

Organization.type.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

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

Fixed value

http://hn.indra.es/hncat/fhir/ValueSet/organization_type

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

Organization.type.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

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

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

codeBinding

Element id

Organization.type.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

http://hl7.org/fhir/CodeSystem/tipo_organization (required)

Binding

Code

Constraints

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

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

stringBinding

Element id

Organization.type.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

http://hl7.org/fhir/CodeSystem/tipo_organization (required)

Binding

Display

Constraints

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

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

Organization.type.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Constraints

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

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..0

There are no (further) constraints on this element

Element id

Organization.type.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

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

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

name

Σ C

0..1

There are no (further) constraints on this element

Element id

Organization.name

Short description

Name used for the organization

Definition

A name associated with the organization.

Requirements

Need to use the name as the label of the organization.

Comments

If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: org-1

Constraints

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

Mappings

v2: XON.1
rim: .name
servd: .PreferredName/Name

alias

0..0

There are no (further) constraints on this element

Element id

Organization.alias

Short description

A list of alternate names that the organization is known as, or was known as in the past

Definition

A list of alternate names that the organization is known as, or was known as in the past.

Requirements

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the organization was known by can be very useful.

Comments

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

Data type

Constraints

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

Mappings

rim: .name

telecom

0..0

There are no (further) constraints on this element

Element id

Organization.telecom

Short description

A contact detail for the organization

Definition

A contact detail for the organization.

Requirements

Human contact for the organization.

Comments

The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: org-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
org-3: The telecom of an organization can never be of use 'home'
where(use = 'home').empty()

Mappings

v2: ORC-22?
rim: .telecom
servd: ./ContactPoints

address

0..0

There are no (further) constraints on this element

Element id

Organization.address

Short description

An address for the organization

Definition

An address for the organization.

Requirements

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

Comments

Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: org-2

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
org-2: An address of an organization can never be of use 'home'
where(use = 'home').empty()

Mappings

v2: ORC-23?
rim: .address
servd: ./PrimaryAddress and ./OtherAddresses

partOf

0..1

There are no (further) constraints on this element

Element id

Organization.partOf

Short description

The organization of which this organization forms a part

Definition

The organization of which this organization forms a part.

Requirements

Need to be able to track the hierarchy of organizations within an organization.

Data type

Constraints

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

Mappings

v2: No equivalent in HL7 v2
rim: .playedBy[classCode=Part].scoper
servd: n/a

0..0

There are no (further) constraints on this element

Element id

Organization.partOf.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Organization.partOf.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

Organization.partOf.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

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

Mappings

rim: N/A

type

0..1

uriBindingFixed Value

Element id

Organization.partOf.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

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.

Comments

Data type

Binding

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

Constraints

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

Fixed value

Organization

Mappings

rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

Organization.partOf.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data type

Constraints

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

Mappings

rim: .identifier

display

0..1

There are no (further) constraints on this element

Element id

Organization.partOf.display

Short description

Text alternative for the resource

Definition

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

Comments

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.

Data type

Constraints

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

Mappings

rim: N/A

contact

0..0

There are no (further) constraints on this element

Element id

Organization.contact

Short description

Contact for the organization for a certain purpose

Definition

Contact for the organization for a certain purpose.

Requirements

Need to keep track of assigned contact points within bigger organization.

Comments

Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

Data type

Constraints

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

Mappings

rim: .contactParty

endpoint

0..0

There are no (further) constraints on this element

Element id

Organization.endpoint

Short description

Technical endpoints providing access to services operated for the organization

Definition

Technical endpoints providing access to services operated for the organization.

Requirements

Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

Data type

Constraints

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

Mappings

rim: n/a

{

"resourceType": "StructureDefinition",
"url": "https://hn.indra.es/fhir/StructureDefinition/Organization",
"name": "Organization",
"status": "draft",
"date": "2024-05-08T11:41:37.1577131+00:00",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Organization",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Organization",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Organization.id",
"path": "Organization.id",
"short": "Identificador lógico asociado al recurso",
"definition": "Identificador lógico del recurso, usado en la URL del mismo, una vez asignado este valor nunca cambia.",
"comment": "El único momento en que un recurso no tiene id es cuando está siendo enviado al servidor usando una operación de creación."
},
{
"id": "Organization.implicitRules",
"path": "Organization.implicitRules",
"max": "0"
},
{
"id": "Organization.language",
"path": "Organization.language",
"max": "0"
},
{
"id": "Organization.text",
"path": "Organization.text",
"max": "0"
},
{
"id": "Organization.contained",
"path": "Organization.contained",
"max": "0"
},
{
"id": "Organization.extension:organizationAlias",
"path": "Organization.extension",
"sliceName": "organizationAlias",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/organization-alias"
]
}
],
"isModifier": false
},
{
"id": "Organization.extension:organizationCareLine",
"path": "Organization.extension",
"sliceName": "organizationCareLine",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/hncat/fhir/Organization/care_line"
]
}
],
"isModifier": false
},
{
"id": "Organization.extension:organizationCenterCode",
"path": "Organization.extension",
"sliceName": "organizationCenterCode",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/center-code"
]
}
],
"isModifier": false
},
{
"id": "Organization.extension:organizationDesc",
"path": "Organization.extension",
"sliceName": "organizationDesc",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/desc-desc"
]
}
],
"isModifier": false
},
{
"id": "Organization.extension:organizationParent",
"path": "Organization.extension",
"sliceName": "organizationParent",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/fhir/StructureDefinition/Organization/parent-organization"
]
}
],
"isModifier": false
},
{
"id": "Organization.extension:organizationSpeciality",
"path": "Organization.extension",
"sliceName": "organizationSpeciality",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/hncat/fhir/ValueSet/speciality"
]
}
],
"isModifier": false
},
{
"id": "Organization.extension:organizationSubType",
"path": "Organization.extension",
"sliceName": "organizationSubType",
"type": [
{
"code": "Extension",
"profile": [
"http://hn.indra.es/hncat/fhir/ValueSet/organization_subtype"
]
}
],
"isModifier": false
},
{
"id": "Organization.identifier.id",
"path": "Organization.identifier.id",
"max": "0"
},
{
"id": "Organization.identifier.use",
"path": "Organization.identifier.use",
"max": "0"
},
{
"id": "Organization.identifier.type.id",
"path": "Organization.identifier.type.id",
"max": "0"
},
{
"id": "Organization.identifier.type.coding.id",
"path": "Organization.identifier.type.coding.id",
"max": "0"
},
{
"id": "Organization.identifier.type.coding.system",
"path": "Organization.identifier.type.coding.system",
"max": "0"
},
{
"id": "Organization.identifier.type.coding.version",
"path": "Organization.identifier.type.coding.version",
"max": "0"
},
{
"id": "Organization.identifier.type.coding.display",
"path": "Organization.identifier.type.coding.display",
"max": "0"
},
{
"id": "Organization.identifier.type.coding.userSelected",
"path": "Organization.identifier.type.coding.userSelected",
"max": "0"
},
{
"id": "Organization.identifier.type.text",
"path": "Organization.identifier.type.text",
"max": "0"
},
{
"id": "Organization.identifier.system",
"path": "Organization.identifier.system",
"max": "0"
},
{
"id": "Organization.identifier.period",
"path": "Organization.identifier.period",
"max": "0"
},
{
"id": "Organization.identifier.assigner",
"path": "Organization.identifier.assigner",
"max": "0"
},
{
"id": "Organization.type.id",
"path": "Organization.type.id",
"max": "0"
},
{
"id": "Organization.type.coding.id",
"path": "Organization.type.coding.id",
"max": "0"
},
{
"id": "Organization.type.coding.system",
"path": "Organization.type.coding.system",
"fixedUri": "http://hn.indra.es/hncat/fhir/ValueSet/organization_type"
},
{
"id": "Organization.type.coding.version",
"path": "Organization.type.coding.version",
"max": "0"
},
{
"id": "Organization.type.coding.code",
"path": "Organization.type.coding.code",
"binding": {
"strength": "required",
"description": "Code",
"valueSet": "http://hl7.org/fhir/CodeSystem/tipo_organization"
}
},
{
"id": "Organization.type.coding.display",
"path": "Organization.type.coding.display",
"binding": {
"strength": "required",
"description": "Display",
"valueSet": "http://hl7.org/fhir/CodeSystem/tipo_organization"
}
},
{
"id": "Organization.type.coding.userSelected",
"path": "Organization.type.coding.userSelected",
"max": "0"
},
{
"id": "Organization.type.text",
"path": "Organization.type.text",
"max": "0"
},
{
"id": "Organization.alias",
"path": "Organization.alias",
"max": "0"
},
{
"id": "Organization.telecom",
"path": "Organization.telecom",
"max": "0"
},
{
"id": "Organization.address",
"path": "Organization.address",
"max": "0"
},
{
"id": "Organization.partOf.id",
"path": "Organization.partOf.id",
"max": "0"
},
{
"id": "Organization.partOf.type",
"path": "Organization.partOf.type",
"fixedUri": "Organization"
},
{
"id": "Organization.partOf.identifier",
"path": "Organization.partOf.identifier",
"max": "0"
},
{
"id": "Organization.contact",
"path": "Organization.contact",
"max": "0"
},
{
"id": "Organization.endpoint",
"path": "Organization.endpoint",
"max": "0"
}
]
}

}

<url value="https://hn.indra.es/fhir/StructureDefinition/Organization" />
<name value="Organization" />
<status value="draft" />
<date value="2024-05-08T11:41:37.1577131+00:00" />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Organization" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Organization" />
<derivation value="constraint" />
<differential>
<element id="Organization.id">
<path value="Organization.id" />
<short value="Identificador lógico asociado al recurso" />
<definition value="Identificador lógico del recurso, usado en la URL del mismo, una vez asignado este valor nunca cambia." />
<comment value="El único momento en que un recurso no tiene id es cuando está siendo enviado al servidor usando una operación de creación." />
</element>
<element id="Organization.implicitRules">
<path value="Organization.implicitRules" />
<max value="0" />
</element>
<element id="Organization.language">
<path value="Organization.language" />
<max value="0" />
</element>
<element id="Organization.text">
<path value="Organization.text" />
<max value="0" />
</element>
<element id="Organization.contained">
<path value="Organization.contained" />
<max value="0" />
</element>
<element id="Organization.extension:organizationAlias">
<path value="Organization.extension" />
<sliceName value="organizationAlias" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/organization-alias" />
</type>
<isModifier value="false" />
</element>
<element id="Organization.extension:organizationCareLine">
<path value="Organization.extension" />
<sliceName value="organizationCareLine" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/hncat/fhir/Organization/care_line" />
</type>
<isModifier value="false" />
</element>
<element id="Organization.extension:organizationCenterCode">
<path value="Organization.extension" />
<sliceName value="organizationCenterCode" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/center-code" />
</type>
<isModifier value="false" />
</element>
<element id="Organization.extension:organizationDesc">
<path value="Organization.extension" />
<sliceName value="organizationDesc" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/desc-desc" />
</type>
<isModifier value="false" />
</element>
<element id="Organization.extension:organizationParent">
<path value="Organization.extension" />
<sliceName value="organizationParent" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/fhir/StructureDefinition/Organization/parent-organization" />
</type>
<isModifier value="false" />
</element>
<element id="Organization.extension:organizationSpeciality">
<path value="Organization.extension" />
<sliceName value="organizationSpeciality" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/hncat/fhir/ValueSet/speciality" />
</type>
<isModifier value="false" />
</element>
<element id="Organization.extension:organizationSubType">
<path value="Organization.extension" />
<sliceName value="organizationSubType" />
<type>
<code value="Extension" />
<profile value="http://hn.indra.es/hncat/fhir/ValueSet/organization_subtype" />
</type>
<isModifier value="false" />
</element>
<element id="Organization.identifier.id">
<path value="Organization.identifier.id" />
<max value="0" />
</element>
<element id="Organization.identifier.use">
<path value="Organization.identifier.use" />
<max value="0" />
</element>
<element id="Organization.identifier.type.id">
<path value="Organization.identifier.type.id" />
<max value="0" />
</element>
<element id="Organization.identifier.type.coding.id">
<path value="Organization.identifier.type.coding.id" />
<max value="0" />
</element>
<element id="Organization.identifier.type.coding.system">
<path value="Organization.identifier.type.coding.system" />
<max value="0" />
</element>
<element id="Organization.identifier.type.coding.version">
<path value="Organization.identifier.type.coding.version" />
<max value="0" />
</element>
<element id="Organization.identifier.type.coding.display">
<path value="Organization.identifier.type.coding.display" />
<max value="0" />
</element>
<element id="Organization.identifier.type.coding.userSelected">
<path value="Organization.identifier.type.coding.userSelected" />
<max value="0" />
</element>
<element id="Organization.identifier.type.text">
<path value="Organization.identifier.type.text" />
<max value="0" />
</element>
<element id="Organization.identifier.system">
<path value="Organization.identifier.system" />
<max value="0" />
</element>
<element id="Organization.identifier.period">
<path value="Organization.identifier.period" />
<max value="0" />
</element>
<element id="Organization.identifier.assigner">
<path value="Organization.identifier.assigner" />
<max value="0" />
</element>
<element id="Organization.type.id">
<path value="Organization.type.id" />
<max value="0" />
</element>
<element id="Organization.type.coding.id">
<path value="Organization.type.coding.id" />
<max value="0" />
</element>
<element id="Organization.type.coding.system">
<path value="Organization.type.coding.system" />
<fixedUri value="http://hn.indra.es/hncat/fhir/ValueSet/organization_type" />
</element>
<element id="Organization.type.coding.version">
<path value="Organization.type.coding.version" />
<max value="0" />
</element>
<element id="Organization.type.coding.code">
<path value="Organization.type.coding.code" />
<binding>
<strength value="required" />
<description value="Code" />
<valueSet value="http://hl7.org/fhir/CodeSystem/tipo_organization" />
</binding>
</element>
<element id="Organization.type.coding.display">
<path value="Organization.type.coding.display" />
<binding>
<strength value="required" />
<description value="Display" />
<valueSet value="http://hl7.org/fhir/CodeSystem/tipo_organization" />
</binding>
</element>
<element id="Organization.type.coding.userSelected">
<path value="Organization.type.coding.userSelected" />
<max value="0" />
</element>
<element id="Organization.type.text">
<path value="Organization.type.text" />
<max value="0" />
</element>
<element id="Organization.alias">
<path value="Organization.alias" />
<max value="0" />
</element>
<element id="Organization.telecom">
<path value="Organization.telecom" />
<max value="0" />
</element>
<element id="Organization.address">
<path value="Organization.address" />
<max value="0" />
</element>
<element id="Organization.partOf.id">
<path value="Organization.partOf.id" />
<max value="0" />
</element>
<element id="Organization.partOf.type">
<path value="Organization.partOf.type" />
<fixedUri value="Organization" />
</element>
<element id="Organization.partOf.identifier">
<path value="Organization.partOf.identifier" />
<max value="0" />
</element>
<element id="Organization.contact">
<path value="Organization.contact" />
<max value="0" />
</element>
<element id="Organization.endpoint">
<path value="Organization.endpoint" />
<max value="0" />
</element>
</differential>

</StructureDefinition>

CareTeam

Descripción del recurso CareTeam

CareTeam

There are no (further) constraints on this element

Element id

CareTeam

Short description

Planned participants in the coordination and delivery of care for a patient or group

Definition

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.

Data type

Constraints

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

Mappings

rim: Entity. Role, or Act

0..1

There are no (further) constraints on this element

Element id

CareTeam.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

CareTeam.meta

Short description

Metadata about the resource

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.

Data type

Constraints

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

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

CareTeam.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

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

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

CareTeam.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

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

text

0..1

There are no (further) constraints on this element

Element id

CareTeam.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

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

Mappings

rim: Act.text?

contained

0..0

There are no (further) constraints on this element

Element id

CareTeam.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

0..*

Element id

CareTeam.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Constraints

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

Mappings

rim: N/A

temporalidad

0..*

Element id

CareTeam.extension:temporalidad

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/careteam/temporality

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

motivo

0..*

Element id

CareTeam.extension:motivo

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/careteam/reason

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

CareTeam.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

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

Requirements

Comments

Data type

Constraints

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

Mappings

rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

CareTeam.identifier

Short description

External Ids for this team

Definition

Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Requirements

Allows identification of the care team as it is known by various participating systems and in a way that remains consistent across servers.

Comments

Data type

Constraints

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

Mappings

w5: FiveWs.identifier

status

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

CareTeam.status

Short description

proposed | active | suspended | inactive | entered-in-error

Definition

Indicates the current state of the care team.

Comments

This element is labeled as a modifier because the status contains the code entered-in-error that marks the care team as not currently valid.

Data type

Binding

Indicates the status of the care team.

CareTeamStatus (required)

Constraints

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

Mappings

w5: FiveWs.status

PractitionerRole

Descripción del recurso PractitionerRole

Esta especificación describe la representación FHIR del recurso PractitionerRole que asocia un recurso practitioner con un puesto dentro de la organización. Los recursos practitionerRole se reciben vía interoperabilidad.

PractitionerRole

PractitionerRole

There are no (further) constraints on this element

Element id

PractitionerRole

Short description

Roles/organizations the practitioner is associated with

Definition

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

Data type

PractitionerRole

Constraints

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

Mappings

rim: Entity. Role, or Act
v2: PRD (as one example)
rim: Role
servd: ServiceSiteProvider

0..1

Element id

PractitionerRole.id

Short description

Identificador lógico asociado al practitionerRole

Definition

Identificador lógico del recurso, usado en la URL del mismo, una vez asignado este valor nunca cambia.

Comments

El único momento en que un recurso no tiene id es cuando está siendo enviado al servidor usando una operación de creación.

Data type

meta

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.meta

Short description

Metadata about the resource

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.

Data type

Constraints

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

implicitRules

Σ ?!

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Constraints

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

language

0..0

codeBinding

There are no (further) constraints on this element

Element id

PractitionerRole.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Binding extensions

maxValueSet	AllLanguages

Constraints

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

text

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Constraints

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

Mappings

rim: Act.text?

contained

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: N/A

extension

0..*

Element id

PractitionerRole.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Constraints

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

Mappings

rim: N/A

practitionerProfession

0..*

Element id

PractitionerRole.extension:practitionerProfession

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/practitioner-profession

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

practitionerScopeCode

0..*

Element id

PractitionerRole.extension:practitionerScopeCode

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

http://hn.indra.es/fhir/StructureDefinition/practitioner-scope-code

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: N/A
rim: n/a

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

PractitionerRole.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

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

Requirements

Comments

Data type

Constraints

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

Mappings

rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.identifier

Short description

Business Identifiers that are specific to a role/location

Definition

Business Identifiers that are specific to a role/location.

Requirements

Often, specific identities are assigned for the agent.

Data type

Constraints

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

Mappings

w5: FiveWs.identifier
v2: PRD-7 (or XCN.1)
rim: .id
servd: ./Identifiers

active

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.active

Short description

Whether this practitioner role record is in active use

Definition

Whether this practitioner role record is in active use.

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.

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 when missing

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

Data type

Constraints

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

Mappings

w5: FiveWs.status
v2: STF-7
rim: .statusCode

period

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.period

Short description

The period during which the practitioner is authorized to perform in these role(s)

Definition

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

Requirements

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

Data type

Constraints

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

Mappings

w5: FiveWs.done[x]
v2: PRD-8/9 / PRA-5.4
rim: .performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime
servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)

practitioner

0..1

Reference(Practitioner)

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner

Short description

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

Definition

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

Data type

Reference(Practitioner)

Constraints

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

Mappings

rim: .player

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

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

Mappings

rim: N/A

type

0..1

uriBindingFixed Value

Element id

PractitionerRole.practitioner.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

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.

Comments

Data type

Binding

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

Constraints

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

Fixed value

Practitioner

Mappings

rim: N/A

identifier

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data type

Constraints

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

Mappings

rim: .identifier

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner.identifier.type

Short description

Description of identifier

Definition

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

Requirements

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

Comments

Data type

Binding

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

Constraints

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

Mappings

v2: CX.5
rim: Role.code or implied by context

system

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

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

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner.identifier.value

Short description

The value that is unique

Definition

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

Comments

Data type

Constraints

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

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

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

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

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

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner.display

Short description

Text alternative for the resource

Definition

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

Comments

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.

Data type

Constraints

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

Mappings

rim: N/A

organization

0..1

Element id

PractitionerRole.organization

Short description

Unidad organizativa relacionada con este rol

Definition

Este tag únicamente se enviará en el caso que el tipo de permiso sea de tipo Centro, esto viene definido por la extensión practitioner-scope-code

Data type

Constraints

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

Mappings

rim: .scoper

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.organization.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

PractitionerRole.organization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

reference

Σ C

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.organization.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ref-1

Constraints

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

Mappings

rim: N/A

type

0..1

uriBindingFixed Value

Element id

PractitionerRole.organization.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

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.

Comments

Data type

Binding

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

Constraints

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

Fixed value

Organization

Mappings

rim: N/A

identifier

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.organization.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data type

Constraints

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

Mappings

rim: .identifier

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.organization.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

PractitionerRole.organization.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

use

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

PractitionerRole.organization.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

PractitionerRole.organization.identifier.type

Short description

Description of identifier

Definition

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

Requirements

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

Comments

Data type

Binding

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

Constraints

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

Mappings

v2: CX.5
rim: Role.code or implied by context

system

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.organization.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

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

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.organization.identifier.value

Short description

The value that is unique

Definition

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

Comments

Data type

Constraints

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

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.organization.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

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

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.organization.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Constraints

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

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.organization.display

Short description

Text alternative for the resource

Definition

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

Comments

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.

Data type

Constraints

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

Mappings

rim: N/A

code

0..*

There are no (further) constraints on this element

Element id

PractitionerRole.code

Short description

Roles which this practitioner may perform

Definition

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

Requirements

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

Comments

A person may have more than one role.

Data type

Binding

The role a person plays representing an organization.

PractitionerRole (example)

Constraints

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

Mappings

v2: PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17
rim: .code
servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.code.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

PractitionerRole.code.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

coding

0..*

There are no (further) constraints on this element

Element id

PractitionerRole.code.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Constraints

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

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.code.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

PractitionerRole.code.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

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

Mappings

rim: n/a

system

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.code.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

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

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.code.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

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

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

codeBinding

Element id

PractitionerRole.code.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Data type

http://hl7.org/fhir/CodeSystem/tipo_profesional (required)

Binding

Code

Constraints

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

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.code.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Constraints

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

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.code.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

Constraints

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

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

stringBinding

Element id

PractitionerRole.code.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

http://hl7.org/fhir/CodeSystem/tipo_profesional (required)

Binding

Display

Constraints

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

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

specialty

0..0

CodeableConceptBinding

There are no (further) constraints on this element

Element id

PractitionerRole.specialty

Short description

Specific specialty of the practitioner

Definition

Specific specialty of the practitioner.

Data type

PracticeSettingCodeValueSet (preferred)

Binding

Specific specialty associated with the agency.

Constraints

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

Mappings

v2: PRA-5
rim: .player.HealthCareProvider[@classCode = 'PROV'].code
servd: ./Specialty

location

0..0

Reference(Location)

There are no (further) constraints on this element

Element id

PractitionerRole.location

Short description

The location(s) at which this practitioner provides care

Definition

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

Data type

Reference(Location)

Constraints

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

Mappings

w5: FiveWs.where[x]
rim: .performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']
servd: (ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)

healthcareService

0..0

Reference(HealthcareService)

There are no (further) constraints on this element

Element id

PractitionerRole.healthcareService

Short description

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

Definition

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

Data type

Reference(HealthcareService)

Constraints

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

Mappings

v2: EDU-2 / AFF-3
rim: .player.QualifiedEntity[@classCode = 'QUAL'].code

telecom

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.telecom

Short description

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

Definition

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

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.

Data type

Constraints

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

Mappings

rim: .telecom

availableTime

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.availableTime

Short description

Times the Service Site is available

Definition

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

Comments

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

Data type

Constraints

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

Mappings

rim: .effectiveTime

notAvailable

0..0

There are no (further) constraints on this element

Element id

PractitionerRole.notAvailable

Short description

Not available during this time due to provided reason

Definition

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

Data type

Constraints

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

Mappings

rim: .effectiveTime

availabilityExceptions

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.availabilityExceptions

Short description

Description of availability exceptions

Definition

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.

Data type

Constraints

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

Mappings

rim: .effectiveTime

endpoint

0..*

There are no (further) constraints on this element

Element id

PractitionerRole.endpoint

Short description

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

Definition

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

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.

Data type