Work in progress.
This section of the Implementation Guide is subject to change.

Profile EEBasePractitioner


Profile Purpose

This profile defines the EE Base constraints and extensions on the Practitioner resource for the minimal set of data to query and retrieve practitioner information. The profile defines a structure that localises core concepts, including identifiers and terminology, for use in an Estonian context for practitioner.

Example usage scenarios

  • Query for qualification(s) of the practitioner using the query parameter Practitioner.qualification.code
  • Query for practitioners who are active in their position with query parameter Practitioner.active
  • Exchange Practitioner information within a FHIR document or message


Snapshot View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
medre-tam-idS Σ0..1EEBase Medre TAM Practitioner ID
est-idS Σ0..1EEBase Estonian Personal Identification Number
activeΣ0..1boolean
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
textΣ0..1string
familyS Σ1..1string
givenS Σ1..1string
prefixΣ0..*string
suffixΣ0..*string
periodΣ I0..1Period
telecomΣ I0..*ContactPoint
addressΣ0..*EEBase Address
genderΣ0..1codeBinding
birthDateΣ0..1date
photoI0..*Attachment
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
identifier0..*Identifier
code1..1CodeableConcept
periodI0..1Period
issuerI0..1Reference(EEBase Organization)
communication0..*CodeableConceptBinding

Differential View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
medre-tam-idS Σ0..1EEBase Medre TAM Practitioner ID
est-idS Σ0..1EEBase Estonian Personal Identification Number
activeΣ0..1boolean
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
textΣ0..1string
familyS Σ1..1string
givenS Σ1..1string
prefixΣ0..*string
suffixΣ0..*string
periodΣ I0..1Period
telecomΣ I0..*ContactPoint
addressΣ0..*EEBase Address
genderΣ0..1codeBinding
birthDateΣ0..1date
photoI0..*Attachment
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
identifier0..*Identifier
code1..1CodeableConcept
periodI0..1Period
issuerI0..1Reference(EEBase Organization)
communication0..*CodeableConceptBinding

Hybrid View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
medre-tam-idS Σ0..1EEBase Medre TAM Practitioner ID
est-idS Σ0..1EEBase Estonian Personal Identification Number
activeΣ0..1boolean
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
textΣ0..1string
familyS Σ1..1string
givenS Σ1..1string
prefixΣ0..*string
suffixΣ0..*string
periodΣ I0..1Period
telecomΣ I0..*ContactPoint
addressΣ0..*EEBase Address
genderΣ0..1codeBinding
birthDateΣ0..1date
photoI0..*Attachment
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
identifier0..*Identifier
code1..1CodeableConcept
periodI0..1Period
issuerI0..1Reference(EEBase Organization)
communication0..*CodeableConceptBinding

Table View

Practitioner..
Practitioner.identifier1..
Practitioner.identifierEEBase Medre TAM Practitioner ID..1
Practitioner.identifierEEBase Estonian Personal Identification Number..1
Practitioner.name1..1
Practitioner.name.family1..
Practitioner.name.given1..1
Practitioner.addressEEBase Address..
Practitioner.qualification..
Practitioner.qualification.issuerReference(EEBase Organization)..
Practitioner.communication..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="EEBase-Practitioner" />
    <meta>
        <versionId value="4" />
        <lastUpdated value="2022-11-21T13:15:21.1820806+00:00" />
    </meta>
    <url value="https://hl7.ee/fhir/StructureDefinition/EEBase-Practitioner" />
    <version value="1.0.0" />
    <name value="EEBasePractitioner" />
    <title value="EEBase Practitioner" />
    <status value="draft" />
    <date value="2022-11-21T13:22:24.2179018+00:00" />
    <publisher value="HL7 EE" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Practitioner" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
    <derivation value="constraint" />
    <differential>
        <element id="Practitioner.identifier">
            <path value="Practitioner.identifier" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="system" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.identifier:medre-tam-id">
            <path value="Practitioner.identifier" />
            <sliceName value="medre-tam-id" />
            <short value="Health care provider identificator" />
            <definition value="Riiklikku registrisse kantud tervishoiut&#246;&#246;taja kood" />
            <max value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://hl7.ee/fhir/StructureDefinition/ee-medre-pid" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.identifier:est-id">
            <path value="Practitioner.identifier" />
            <sliceName value="est-id" />
            <definition value="Eesti isikukoodi identifikaator" />
            <max value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://hl7.ee/fhir/StructureDefinition/EEBase-ESTID" />
            </type>
        </element>
        <element id="Practitioner.name">
            <path value="Practitioner.name" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.name.family">
            <path value="Practitioner.name.family" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.name.given">
            <path value="Practitioner.name.given" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.address">
            <path value="Practitioner.address" />
            <type>
                <code value="Address" />
                <profile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Address" />
            </type>
        </element>
        <element id="Practitioner.qualification.issuer">
            <path value="Practitioner.qualification.issuer" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Organization" />
            </type>
        </element>
        <element id="Practitioner.communication">
            <path value="Practitioner.communication" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
                    <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" />
                </extension>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="Language" />
                </extension>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
                    <valueBoolean value="true" />
                </extension>
                <strength value="preferred" />
                <valueSet value="http://hl7.org/fhir/ValueSet/all-languages" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "EEBase-Practitioner",
    "meta": {
        "versionId": "4",
        "lastUpdated": "2022-11-21T13:15:21.1820806+00:00"
    },
    "url": "https://hl7.ee/fhir/StructureDefinition/EEBase-Practitioner",
    "version": "1.0.0",
    "name": "EEBasePractitioner",
    "title": "EEBase Practitioner",
    "status": "draft",
    "date": "2022-11-21T13:22:24.2179018+00:00",
    "publisher": "HL7 EE",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Practitioner",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Practitioner",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Practitioner.identifier",
                "path": "Practitioner.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "rules": "open"
                },
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Practitioner.identifier:medre-tam-id",
                "path": "Practitioner.identifier",
                "sliceName": "medre-tam-id",
                "short": "Health care provider identificator",
                "definition": "Riiklikku registrisse kantud tervishoiutöötaja kood",
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://hl7.ee/fhir/StructureDefinition/ee-medre-pid"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Practitioner.identifier:est-id",
                "path": "Practitioner.identifier",
                "sliceName": "est-id",
                "definition": "Eesti isikukoodi identifikaator",
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-ESTID"
                        ]
                    }
                ]
            },
            {
                "id": "Practitioner.name",
                "path": "Practitioner.name",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Practitioner.name.family",
                "path": "Practitioner.name.family",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Practitioner.name.given",
                "path": "Practitioner.name.given",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Practitioner.address",
                "path": "Practitioner.address",
                "type":  [
                    {
                        "code": "Address",
                        "profile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Address"
                        ]
                    }
                ]
            },
            {
                "id": "Practitioner.qualification.issuer",
                "path": "Practitioner.qualification.issuer",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Practitioner.communication",
                "path": "Practitioner.communication",
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
                            "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
                        },
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "Language"
                        },
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
                            "valueBoolean": true
                        }
                    ],
                    "strength": "preferred",
                    "valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
                }
            }
        ]
    }
}


identifier (Must support)

This is a mandatory data element.
The values allowed for this data element are limited and MUST originate from the systems defined by TAM code or Estonian Personal Identification Number.
Business identifier for identifying the practitioner across multiple systems.
At least one value (identifier.value) MUST be provided: tam.value should be populated if the practitioner is licenced by the Estonian Health Board, alternatively, est-id.value should be populated in case the practitioner does not have a TAM code.

active

Whether this practitioner's record is in active use.


name (Must support)

This is a mandatory data element.
The name(s) that the practitioner is known by. Please note that name.family and name.given use Must Support flags as well.

telecom

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


address

Please note that the Address datatype used by this element has been standardized, see Address profile for more details.
Address(es) of the practitioner that are not role specific (typically home address).

gender

The gender that the person is considered to have for administration and record keeping purposes. The required ValueSet used in this case is administrative-gender, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.

HTML View

This code system http://hl7.org/fhir/administrative-gender defines the following codes:

CodeDisplayDefinition
maleMaleMale.
femaleFemaleFemale.
otherOtherOther.
unknownUnknownUnknown.

Table View

CodeSystem.id[0]administrative-gender
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].value[0]pa
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].value[0]normative
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].value[0]5
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
CodeSystem.extension[3].value[0]4.0.0
CodeSystem.url[0]http://hl7.org/fhir/administrative-gender
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.2
CodeSystem.version[0]4.0.1
CodeSystem.name[0]AdministrativeGender
CodeSystem.title[0]AdministrativeGender
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.description[0]The gender of a person used for administrative purposes.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/administrative-gender
CodeSystem.content[0]complete
CodeSystem.concept[0].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[0].extension[0].value[0]Male
CodeSystem.concept[0].code[0]male
CodeSystem.concept[0].display[0]Male
CodeSystem.concept[0].definition[0]Male.
CodeSystem.concept[1].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[1].extension[0].value[0]Female
CodeSystem.concept[1].code[0]female
CodeSystem.concept[1].display[0]Female
CodeSystem.concept[1].definition[0]Female.
CodeSystem.concept[2].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[2].extension[0].value[0]The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value.
CodeSystem.concept[2].code[0]other
CodeSystem.concept[2].display[0]Other
CodeSystem.concept[2].definition[0]Other.
CodeSystem.concept[3].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[3].extension[0].value[0]A proper value is applicable, but not known. Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless: Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)
CodeSystem.concept[3].code[0]unknown
CodeSystem.concept[3].display[0]Unknown
CodeSystem.concept[3].definition[0]Unknown.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="administrative-gender" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <url value="http://hl7.org/fhir/administrative-gender" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.2" />
    </identifier>
    <version value="4.0.1" />
    <name value="AdministrativeGender" />
    <title value="AdministrativeGender" />
    <status value="active" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <description value="The gender of a person used for administrative purposes." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/administrative-gender" />
    <content value="complete" />
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="Male" />
        </extension>
        <code value="male" />
        <display value="Male" />
        <definition value="Male." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="Female" />
        </extension>
        <code value="female" />
        <display value="Female" />
        <definition value="Female." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value." />
        </extension>
        <code value="other" />
        <display value="Other" />
        <definition value="Other." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="A proper value is applicable, but not known.  Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:  Those properties themselves directly translate to a semantic of &quot;unknown&quot;. (E.g. a local code sent as a translation that conveys &#39;unknown&#39;) Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of &quot;H&quot; and a URL prefix of &quot;tel:&quot; to convey that it is the home phone number that is unknown.)" />
        </extension>
        <code value="unknown" />
        <display value="Unknown" />
        <definition value="Unknown." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "administrative-gender",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        }
    ],
    "url": "http://hl7.org/fhir/administrative-gender",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.2"
        }
    ],
    "version": "4.0.1",
    "name": "AdministrativeGender",
    "title": "AdministrativeGender",
    "status": "active",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "description": "The gender of a person used for administrative purposes.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender",
    "content": "complete",
    "concept":  [
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "Male"
                }
            ],
            "code": "male",
            "display": "Male",
            "definition": "Male."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "Female"
                }
            ],
            "code": "female",
            "display": "Female",
            "definition": "Female."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value."
                }
            ],
            "code": "other",
            "display": "Other",
            "definition": "Other."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "A proper value is applicable, but not known.  Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:  Those properties themselves directly translate to a semantic of \"unknown\". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of \"H\" and a URL prefix of \"tel:\" to convey that it is the home phone number that is unknown.)"
                }
            ],
            "code": "unknown",
            "display": "Unknown",
            "definition": "Unknown."
        }
    ]
}


birthDate

The date of birth for the practitioner.


photo

A photograph relating to the practitioner.


qualification

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 Estonian Health Board authorizing the practitioner to practice medicine. Coded value of the practitioner's qualification. The ValueSet used in this case is v2-2.7-0360. As a value set with Example binding, using this value set is not strictly expected.


communication

A language that the practitioner is able to use to communicate with patients about their health. The preferred ValueSet used in this case is languages, meaning these values SHOULD be exchanged, however other ValueSets (either local or developed and published by the community) may be used if required. In that case mapping other ValueSets to observation-category by using the ConceptMap resource is encouraged.