Guia de Implementação da OMNISAUDE - CORE
0.0.1 - draft Brazil flag

Guia de Implementação da OMNISAUDE - CORE - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Practitioner (OMNI)

Official URL: https://fhir.omnisaude.co/r4/core/StructureDefinition/profissional Version: 0.0.1
Draft as of 2025-04-10 Computable Name: Profissional

Practitioner Profile da Omnisaude baseado no IPS.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* PractitionerUvIps A person with a formal responsibility in the provisioning of healthcare or related services
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 1..* Identifier An identifier for the person as this agent
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


ele-1: All FHIR elements must have a @value or children
.... text Σ 1..1 string Text representation of the full name
ele-1: All FHIR elements must have a @value or children
.... family SΣ 0..1 string Family name (often called 'Surname')
ele-1: All FHIR elements must have a @value or children
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
ele-1: All FHIR elements must have a @value or children
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom SΣ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
ele-1: All FHIR elements must have a @value or children
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
... address SΣ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
.... Slices for line Σ 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:bairro Σ 0..1 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
..... line:logradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
..... line:tipoLogradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
..... line:numero Σ 0..1 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
..... line:complemento Σ 0..1 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
.... city Σ 0..1 string Name of city, town etc.
Binding: Município (extensible)
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
ele-1: All FHIR elements must have a @value or children
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Practitioner.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Practitioner.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Practitioner.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf 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-4errorPractitionerIf 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-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from PractitionerUvIps

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner PractitionerUvIps
... identifier 1..* Identifier An identifier for the person as this agent
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... name
.... text 1..1 string Text representation of the full name
... telecom
.... system 1..1 code phone | fax | email | pager | url | sms | other
.... value 1..1 string The actual contact point details
.... Slices for line 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
..... line:bairro 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
..... line:logradouro 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
..... line:tipoLogradouro 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
..... line:numero 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
..... line:complemento 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
.... city 0..1 string Name of city, town etc.
Binding: Município (extensible)
.... state 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Practitioner.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Practitioner.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Practitioner.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Practitioner.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* PractitionerUvIps A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier An identifier for the person as this agent
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active Σ 0..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..* HumanName The name(s) associated with the practitioner
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ 1..1 string Text representation of the full name
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address SΣ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... Slices for line Σ 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:bairro Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:logradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:tipoLogradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:numero Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:complemento Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
.... city Σ 0..1 string Name of city, town etc.
Binding: Município (extensible)
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the practitioner was born
... photo 0..* Attachment Image of the person
... qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..* Identifier An identifier for this qualification for the practitioner
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.

.... period 0..1 Period Period during which the qualification is valid
.... issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Practitioner.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Practitioner.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Practitioner.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Practitioner.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf 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-4errorPractitionerIf 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-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from PractitionerUvIps

Summary

Mandatory: 4 elements(2 nested mandatory elements)

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Practitioner.address.line

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* PractitionerUvIps A person with a formal responsibility in the provisioning of healthcare or related services
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 1..* Identifier An identifier for the person as this agent
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


ele-1: All FHIR elements must have a @value or children
.... text Σ 1..1 string Text representation of the full name
ele-1: All FHIR elements must have a @value or children
.... family SΣ 0..1 string Family name (often called 'Surname')
ele-1: All FHIR elements must have a @value or children
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
ele-1: All FHIR elements must have a @value or children
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom SΣ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
ele-1: All FHIR elements must have a @value or children
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value Σ 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
... address SΣ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


ele-1: All FHIR elements must have a @value or children
Example General: home
.... Slices for line Σ 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:bairro Σ 0..1 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
..... line:logradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
..... line:tipoLogradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
..... line:numero Σ 0..1 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
..... line:complemento Σ 0..1 string Street name, number, direction & P.O. Box etc.
ele-1: All FHIR elements must have a @value or children
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
.... city Σ 0..1 string Name of city, town etc.
Binding: Município (extensible)
ele-1: All FHIR elements must have a @value or children
Example General: Erewhon
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
ele-1: All FHIR elements must have a @value or children
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Practitioner.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Practitioner.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Practitioner.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf 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-4errorPractitionerIf 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-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from PractitionerUvIps

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner PractitionerUvIps
... identifier 1..* Identifier An identifier for the person as this agent
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... name
.... text 1..1 string Text representation of the full name
... telecom
.... system 1..1 code phone | fax | email | pager | url | sms | other
.... value 1..1 string The actual contact point details
.... Slices for line 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
..... line:bairro 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
..... line:logradouro 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
..... line:tipoLogradouro 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
..... line:numero 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
..... line:complemento 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
.... city 0..1 string Name of city, town etc.
Binding: Município (extensible)
.... state 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Practitioner.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Practitioner.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Practitioner.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Practitioner.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* PractitionerUvIps A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier An identifier for the person as this agent
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active Σ 0..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..* HumanName The name(s) associated with the practitioner
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ 1..1 string Text representation of the full name
.... family SΣ 0..1 string Family name (often called 'Surname')
.... given SΣ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address SΣ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... Slices for line Σ 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:bairro Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:logradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:tipoLogradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:numero Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:complemento Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
.... city Σ 0..1 string Name of city, town etc.
Binding: Município (extensible)
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the practitioner was born
... photo 0..* Attachment Image of the person
... qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..* Identifier An identifier for this qualification for the practitioner
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.

.... period 0..1 Period Period during which the qualification is valid
.... issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Practitioner.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Practitioner.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Practitioner.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Practitioner.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Practitioner.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf 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-4errorPractitionerIf 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-5errorPractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from PractitionerUvIps

Summary

Mandatory: 4 elements(2 nested mandatory elements)

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Practitioner.address.line

 

Other representations of profile: CSV, Excel, Schematron