Implementation Guide for Portuguese Use Cases

ProfilePTPS/PractitionerPTPS.StructureDefinition.json

Tree view

PractitionerPTPS (Practitioner)	I		PractitionerPTCore	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 Morada do profissional Data type PractitionerPTCore Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim: Entity. Role, or Act v2: PRD (as one example) rim: Role servd: Provider w5: administrative.individual
id	Σ	1..1	id	There are no (further) constraints on this element Element id Practitioner.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 id
meta	Σ	0..1	MetaPTCore	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 MetaPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	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 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 uri Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
language		0..1	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 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 code Binding IETF language tag CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a
text		0..1	Narrative	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 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 Narrative Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a rim: N/A rim: Act.text?
contained	I	0..*	Resource	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 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 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 Resource Constraints dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..0	Extension	There are no (further) constraints on this element Element id Practitioner.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 Extension Sliced: 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 unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	?! I	0..*	Extension	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 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 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 Extension Sliced: 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 unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
identifier	Σ	1..*	ExtensionIdentifierPTCore	There are no (further) constraints on this element Element id Practitioner.identifier Short description An identifier intended for computation Definition Identificadores do profissional Requirements Often, specific identities are assigned for the agent. Data type ExtensionIdentifierPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier w5: FiveWs.identifier v2: PRD-7 (or XCN.1) rim: ./id servd: ./Identifiers
id		0..1	id	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 id Mappings rim: n/a
extension	I	0..*	Extension	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 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 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 Extension Sliced: 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 unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` 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.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition Propósito do identificador: official: O identificador considerado mais fiável para a identificação do item. temp: Um identificador temporário. secondary: Um identificador que foi atribuído para identificar o item em um contexto relativo, mas não pode usado em um contexto diferente. old: O identificador já não é considerado válido, mas pode ser relevante para fins de pesquisa. 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 code Binding IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptPTCoreBinding	There are no (further) constraints on this element Element id Practitioner.identifier.type Short description Concept - reference to a terminology or just text Definition A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments Value Set: ExtensionIdentifierType Data type CodeableConceptPTCore Binding ExtensionIdentifierType (extensible) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD v2: CX.5 rim: Role.code or implied by context
id		0..1	id	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 id Mappings rim: n/a
extension	I	0..*	Extension	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 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 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 Extension Sliced: 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 unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
coding	Σ	0..*	CodingPTCore	There are no (further) constraints on this element Element id Practitioner.identifier.type.coding Short description A reference to a 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. Data type CodingPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim: CV orim: fhir:Coding rdfs:subClassOf dt:CDCoding v2: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1	id	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. Comments . Data type id Mappings rim: n/a
extension	I	0..*	Extension	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 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 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 Extension Sliced: 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 unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
system	Σ	1..1	uri	There are no (further) constraints on this element 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 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 uri Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.3 rim:* ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..0	string	There are no (further) constraints on this element Element id Practitioner.identifier.type.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 string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	Σ	1..1	code	There are no (further) constraints on this element 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. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	1..1	string	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. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.2 - but note this is not well followed rim:* CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..0	boolean	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 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 boolean Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a 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	Σ	1..1	string	There are no (further) constraints on this element 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 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 string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
system	Σ	0..1	uri	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 Para sistemas geridos pela SPMS o system tem de seguir a seguinte estrutura: http://spms.min-saude.pt/<sistema>/identifiers/<identifier-id> Data type uri Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Examples General http://www.acme.com/identifiers/patient Mappings rim: n/a v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	Σ	1..1	string	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 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 string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Examples General 123456 Mappings rim: n/a 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	Σ I	0..1	PeriodPTCore	There are no (further) constraints on this element Element id Practitioner.identifier.period Short description Time range defined by start and end date/time Alternate names Period Definition A time period defined by a start and end date and optionally time. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data type PeriodPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ I	0..0	Reference(OrganizationPTCore)	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 Reference(OrganizationPTCore) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` ref-1: SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) 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..0	boolean	There are no (further) constraints on this element Element id Practitioner.active Short description Whether this practitioner's record is in active use Definition Indica se o profissional se encontra ativo ou inativo 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 boolean Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a w5: FiveWs.status rim: ./statusCode
name	Σ	1..*	HumanNamePTCore	There are no (further) constraints on this element Element id Practitioner.name Short description Name of a human - parts and usage Definition Nome do profissional 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 Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. Data type HumanNamePTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: XPN rim: EN (actually, PN) servd: ProviderName v2: XCN Components rim: ./name servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
id		0..1	id	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 id Mappings rim: n/a
extension	I	0..*	Extension	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 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 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 Extension Sliced: 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 unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` 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 usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Indica a finalidade do nome: “official”: Nome oficial. “usual”: Nome profissional. “old”: Nome antigo (após “merge” de utentes/profissionais). “anonymous”: Este HumanNameUse será utilizado quando se pretende proteger a identidade da pessoa pode ser atribuído o nome anónimo, sigla ou pseudónimo. “temp “: O Nome temporário será utilizado para esclarecer o período associado à utilização deste HumanNameUse. Este poderá ser utilizado para nomes temporários atribuídos no nascimento ou em situações de emergência. “maiden”: Nome utilizado antes da mudança de nome por causa do casamento. “nickname”: Nome informal atribuído à pessoa. 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 code Binding NameUse (required) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: XPN.7, but often indicated by which field contains the name rim: unique(./use) servd: ./NamePurpose
text	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.name.text Short description Text representation of the full name Definition Nome completo 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 string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: implied by XPN.11 rim: ./formatted
family	Σ	0..1	string	There are no (further) constraints on this element Element id Practitioner.name.family Short description Family name (often called 'Surname') Alternate names surname Definition Apelidos Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data type string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: XPN.1/FN.1 rim: ./part[partType = FAM] servd: ./FamilyName
given	Σ	0..*	string	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 Nomes próprios 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 string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: XPN.2 + XPN.3 rim: ./part[partType = GIV] servd: ./GivenNames
prefix	Σ	0..*	string	There are no (further) constraints on this element Element id Practitioner.name.prefix Short description Parts that come before the name Definition Prefixo Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: XPN.5 rim: ./part[partType = PFX] servd: ./TitleCode
suffix	Σ	0..*	string	There are no (further) constraints on this element Element id Practitioner.name.suffix Short description Parts that come after the name Definition Sufixo Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: XPN/4 rim: ./part[partType = SFX]
period	Σ I	0..1	PeriodPTCore	There are no (further) constraints on this element Element id Practitioner.name.period Short description Time range defined by start and end date/time Alternate names Period Definition Período de tempo em que o nome estava/está em uso. Requirements Allows names to be placed in historical context. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data type PeriodPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` per-1: If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim: n/a v2: DR rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2: XPN.13 + XPN.14 rim: ./usablePeriod[type="IVL<TS>"] servd: ./StartDate and ./EndDate
telecom	Σ I	0..0	ContactPointPTCore	There are no (further) constraints on this element Element id Practitioner.telecom Short description Details of a Technology mediated contact point (phone, fax, email, etc.) Definition Contactos do profissional 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 ContactPointPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` cpt-2: A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim: n/a v2: XTN rim: TEL servd: ContactPoint v2: PRT-15, STF-10, ROL-12 rim: ./telecom servd: ./ContactPoints
address	Σ	0..0	AddressPTCore	There are no (further) constraints on this element Element id Practitioner.address Short description An address expressed using postal conventions (as opposed to GPS or other location definition formats) Definition Morada do profissional. Para moradas nacionais é obrigatória a utilização da estrutura de moradas previstas pelos CTT. O atributo address.text será utilizado para descrição de morada de países terceiros e o atributo address.line terá de conter a estrutura da morada nacional definida pelos CTT, tendo de cumprir com a ordenação definida no line. 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 Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). Data type AddressPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: XAD rim: AD servd: Address v2: ORC-24, STF-11, ROL-11, PRT-14 rim: ./addr servd: ./Addresses
gender	Σ	0..0	codeBinding	There are no (further) constraints on this element Element id Practitioner.gender Short description male \| female \| other \| unknown Definition Sexo administrativo. Requirements Needed to address the person correctly. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: STF-5 rim: ./administrativeGender servd: ./GenderCode
birthDate	Σ	0..0	date	There are no (further) constraints on this element Element id Practitioner.birthDate Short description The date on which the practitioner was born Definition Data de nascimento do profissional. Requirements Needed for identification. Data type date Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: STF-6 rim: ./birthTime servd: (not represented in ServD)
photo	I	0..0	AttachmentPTCore	There are no (further) constraints on this element Element id Practitioner.photo Short description Content in a format defined elsewhere Definition Foto do profissional. Requirements Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. Comments When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". Data type AttachmentPTCore Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` att-1: If the Attachment has data, it SHALL have a contentType `data.empty() or contentType.exists()` Mappings rim: n/a v2: ED/RP rim: ED rim: ./subjectOf/ObservationEvent[code="photo"]/value servd: ./ImageURI (only supports the URI reference)
qualification		0..0	BackboneElement	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 BackboneElement Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CER? rim: .playingEntity.playingRole[classCode=QUAL].code servd: ./Qualifications
communication		0..0	CodeableConceptPTCoreBinding	There are no (further) constraints on this element Element id Practitioner.communication Short description Concept - reference to a terminology or just text Definition Identifica o idioma do profissional. Requirements Knowing which language a practitioner speaks can help in facilitating communication with patients. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConceptPTCore Binding IETF language tag AllLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource `hasValue() or (children().count() > id.count()) or $this is Parameters` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD v2: PID-15, NK1-20, LAN-2 rim: ./languageCommunication servd: ./Languages.LanguageSpokenCode

Binding

Path	Strength	ValueSet	Comment
Identifier.type	extensible	https://spms.min-saude.pt/iop/valueset/ExtensionIdentifierType	Value Set: ExtensionIdentifierType

Path

Strength

ValueSet

Comment

Identifier.type

extensible

https://spms.min-saude.pt/iop/valueset/ExtensionIdentifierType

Value Set: ExtensionIdentifierType

Para mais informações sobre a utilização do elemento system consultar Systems.

Binding do FHIR Required

Path	Strength	ValueSet
Practitioner: Identifier.use	required	IdentifierUse
Practitioner: name.use	required	NameUse

Identifiers Type

Estes Identificadores devem ser utilizados no elemento

identifier.type.coding[*]

system	code	display	text
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	TCM-PT	Specialist in traditional chinese medicine practitioner number	Número da cédula profissional especialista em medicina tradicional chinesa
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	PHYTT-PT	Phytotherapist practitioner number	Número da cédula profissional fitoterapeuta
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	FM-PT	Medical physicist practitioner number	Número da cédula profissional do físico médico
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	PSY-PT	Psychologist practitioner number	Número da cédula profissional do psicólogo
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	LTA-PT	Laboratory technician - analysis practitioner number	Número da cédula profissional técnico de análises clínicas e de saúde pública
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	HOMEP-PT	Specialist in homeopathy practitioner number	Número da cédula profissional homeopata
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	ASOC-PT	Social work assistant practitioner number	Número da cédula profissional do assistente social
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	NUTR-PT	Nutritionist practitioner number	Número da cédula profissional do nutricionista
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	APT-PT	Anatomical pathology technician practitioner number	Número da cédula profissional técnico de anatomia patológica, citológica e tanatológica
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	NATU-PT	Specialist in naturopathy practitioner number	Número da cédula profissional do naturopata
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	DIET-PT	Dietitian practitioner number	Número da cédula profissional do dietista
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	PTP-PT	Physiotherapist practitioner number	Número da cédula profissional do fisioterapeuta
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	CHIR-PT	Chiropractor practitioner number	Número da cédula profissional do quiroprático
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	ACUNP-PT	Acupuncturist practitioner number	Número da cédula profissional do acupuntor
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	OD-PT	Orthoptist practitioner number	Número da cédula profissional do técnico de ortóptica
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	AT-PT	Audiology Technician Practitioner Number	Número da Cédula Profissional Técnico de Audiologia
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	CARDT-PT	Cardiopneumology Technician Practitioner Number	Número da Cédula Profissional Técnico de Cardiopneumologia
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	PHART-PT	Pharmacy Technician Practitioner Number	Número da Cédula Profissional Técnico de Farmácia
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	DH-PT	Dental Hygienist Practitioner Number	Número da Cédula Profissional Higienista Oral
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	NMR-PT	Nuclear Medicine Radiographer Practitioner Number	Número da Cédula Profissional Técnico de Medicina Nuclear
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	NT-PT	Neurophysiology technologist Practitioner Number	Número da Cédula Profissional Técnico de Neurofisiologia
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	ORT-PT	Orthotist Practitioner Number	Número da Cédula Profissional Ortoprotésico
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	DT-PT	Dental Technician Practitioner Number	Número da Cédula Profissional Técnico de Prótese Dentária
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	DGR-PT	Diagnostic Radiographer Practitioner Number	Número da Cédula Profissional Técnico de Radiologia
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	TR-PT	Therapeutic Radiographer Practitioner Number	Número da Cédula Profissional Técnico de Radioterapia
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	SLT-PT	Speech and Language Therapist Practitioner Number	Número da Cédula Profissional Terapeuta da Fala
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	OCCT-PT	Occupational Therapist Practitioner Number	Número da Cédula Profissional Terapeuta Ocupacional
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	EHO-PT	Environmental Health Officer Practitioner Number	Número da Cédula Profissional Técnico de Saúde Ambiental
https://spms.min-saude.pt/iop/CodeSystem/IdentifierType	ODTL-PT	Odontologist Practitioner Number	Número da Cédula Profissional Odontologista
http://terminology.hl7.org/CodeSystem/v2-0203	ANON	Anonymous identifier	Identificador Anonimizado
http://terminology.hl7.org/CodeSystem/v2-0203	MD	Medical License number	Número da Cédula Profissional Médica
http://terminology.hl7.org/CodeSystem/v2-0203	RN	Registered Nurse Number	Número da Cédula Profissional de Enfermagem
http://terminology.hl7.org/CodeSystem/v2-0203	RPH	Pharmacist license number	Número da Cédula Profissional Farmacêutica
http://terminology.hl7.org/CodeSystem/v2-0203	DDS	Dentist license number	Número da Cédula Profissional do Médico Dentista
http://terminology.hl7.org/CodeSystem/v2-0203	DPM	Podiatrist license number	Número da Cédula Profissional do Podologista
http://terminology.hl7.org/CodeSystem/v2-0203	DO	Osteopath Practitioner Number	Número da Cédula Profissional Osteopata
http://terminology.hl7.org/CodeSystem/v2-0203	NPI	National Provider Identifier	Número Nacional do Profissional

Regras de implementação

Para além das constraints identificadas pelo FHIR para este recurso devem ser consideradas as constraints que identificamos na tabela infra.

Voltar ao início