Practitioner

References

Practitioner appears in PractitionerRole.practitioner references.

Snapshot

idΣ0..1id
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ I0..*CodingBinding
tagΣ I0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textI0..1Narrative
containedI0..*Resource
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionΣ0..1string
codeS Σ I1..1codeBindingFixed Value
displayΣ I0..1string
userSelectedΣ0..1boolean
textΣ0..1string
systemS Σ1..1uri
valueS Σ I1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
activeS Σ ?!1..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
id0..1string
extensionI0..*Extension
systemΣ I1..1codeBindingFixed Value
valueΣ I1..1string
useΣ ?!1..1codeBindingFixed Value
rankΣ0..1positiveInt
periodΣ I0..1Period
id0..1string
extensionI0..*Extension
systemΣ I1..1codeBindingFixed Value
valueΣ I1..1string
useΣ ?!1..1codeBindingFixed Value
rankΣ0..1positiveInt
periodΣ I0..1Period
id0..1string
extensionI0..*Extension
systemΣ I1..1codeBindingFixed Value
valueΣ I1..1string
useΣ ?!1..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
id0..1string
extensionI0..*Extension
systemΣ I1..1codeBindingFixed Value
valueΣ I1..1string
useΣ ?!1..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
id0..1string
extensionI0..*Extension
systemΣ I1..1codeBindingFixed Value
valueΣ I1..1string
useΣ ?!1..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
genderΣ0..1codeBinding
birthDateΣ0..1date
deceasedBooleanboolean
deceasedDateTimedateTime
addressΣ0..*Address
photoI0..*Attachment
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
identifierI0..*Identifier
code1..1CodeableConcept
periodI0..1Period
issuerI0..1Reference(Organization)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionΣ0..1string
codeS Σ I1..1codeBinding
displayΣ I0..1string
userSelectedΣ0..1boolean
textΣ0..1string
preferred0..1boolean

Click here for more information about the base FHIR Practitioner specification.

JSON structure

This is a template for the FHIR Practitioner. See table below for values description.

{
    "resourceType": "Practitioner",
    "id": "{id}",
    "meta": {
        "versionId": "{versionId}",
        "lastUpdated": "{lastUpdated}",
        "profile":  [
            "http://fhir.akinox.com/r4b/StructureDefinition/Practitioner"
        ]
    },
    "identifier":  [
        {
            "type": {
                "coding":  [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                        "code": "{identifierLicense}"
                    }
                ]
            },
            "system": "urn:oid:2.16.840.1.113883.4.288",
            "value": "{licenseNumber}"
        }
    ],
    "active": "{active}",
    "name":  [
        {
            "family": "{familyName}",
            "given":  [
                "{firstName}"
            ]
        }
    ],
    "telecom":  [
        {
            "system": "phone",
            "value": "{mainPhone}"
        },
        {
            "system": "email",
            "value": "{emailAddress}"
        }
    ],
    "gender": "{gender}",
    "communication":  [
        {
            "coding":  [
                {
                    "code": "{language}"
                }
            ]
        }
    ]
}

Description of the values

Property Description
{id} This is the logical identifier. It is a GUID.
{versionId} The version number of the practitioner. This version number is incremented by Akinox system outside of changes done trought this API.
{lastUpdatedDate} The last updated date of the practitioner
{identifierLicense} Identifier type for the Practitioner. Is a fixed value. (i.e. LN, License number)
{licenseNumber} The practitioner's license number.
{active} The current status. (active or inactive)
{familyName} The practitioner's last name.
{firstName} The first name of the practitioner. Only the first element of the given property is considered
{mainPhone} The practitioner's work phone.
{emailAddress} The practitioner's email address .
{gender} The practitioner's gender.
{language} Specifies the preferred language for communication with the practitioner. Click here for documentation about the valueset. Only the first element of the property is considered.

Notes on typical FHIR errors

  • The identifier.type.coding.code must always be LN. Otherwise, the FHIR validation will raise an error. (it is caps sensitive)
    • See here for further information regarding the types of identifier.
  • If you remove the meta.profile, there will be an error on the FHIR validation.

Business rules

  • Once created, you cannot modify any of those properties {emailAddress}, {licenseNumber} or the {professionCode}. See Http interactions / Practitioner for further information regarding the http error.

Search Parameters

Name Description
identifier Business identifier (License Number) of the practitioner. Matches one unique practitioner

See search examples.