Practitioner - FHIR Resource (stu3)


This Practitioner Resource uses the FHIR API standard for access and structure.

Validate an Practitioner FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
activefalseboolean# Whether this practitioner's record is in active use
addresstrueAddress# Address(es) of the practitioner that are not role specific (typically home address)
birthDatefalsedate# The date on which the practitioner was born
communicationtrueCodeableConcept# A language the practitioner is able to use in patient communication
genderfalsecode# male | female | other | unknown
identifiertrueIdentifier# A identifier for the person as this agent
nametrueHumanName# The name(s) associated with the practitioner
phototrueAttachment# Image of the person
qualificationtrueData Type# Qualifications obtained by training and certification
telecomtrueContactPoint# A contact detail for the practitioner (that apply to all roles)

Practitioner Example

{
  "name": [
    {
      "given": [
        "Adam"
      ],
      "prefix": [
        "Dr"
      ],
      "family": "Careful"
    }
  ],
  "resourceType": "Practitioner",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>Dr Adam Careful is a Referring Practitioner for Acme Hospital from 1-Jan 2012 to 31-Mar\n        2012</p>\n    </div>"
  },
  "qualification": [
    {
      "code": {
        "text": "Bachelor of Science",
        "coding": [
          {
            "code": "BS",
            "system": "http://hl7.org/fhir/v2/0360/2.7",
            "display": "Bachelor of Science"
          }
        ]
      },
      "identifier": [
        {
          "system": "http://example.org/UniversityIdentifier",
          "value": "12345"
        }
      ],
      "period": {
        "start": "1995"
      },
      "issuer": {
        "display": "Example University"
      }
    }
  ],
  "address": [
    {
      "postalCode": "3999",
      "city": "PleasantVille",
      "use": "home",
      "line": [
        "534 Erewhon St"
      ],
      "state": "Vic"
    }
  ],
  "active": true,
  "identifier": [
    {
      "system": "http://www.acme.org/practitioners",
      "value": "23"
    }
  ],
  "id": "example"
}

Practitioner Structure


  
{
  "resourceType" : "Practitioner",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // A identifier for the person as this agent
  "active" : <boolean>, // Whether this practitioner's record is in active use
  "name" : [{ HumanName }], // The name(s) associated with the practitioner
  "telecom" : [{ ContactPoint }], // A contact detail for the practitioner (that apply to all roles)
  "address" : [{ Address }], // Address(es) of the practitioner that are not role specific (typically home address)
  "gender" : "<code>", // male | female | other | unknown
  "birthDate" : "<date>", // The date  on which the practitioner was born
  "photo" : [{ Attachment }], // Image of the person
  "qualification" : [{ // Qualifications obtained by training and certification
    "identifier" : [{ Identifier }], // An identifier for this qualification for the practitioner
    "code" : { CodeableConcept }, // R!  Coded representation of the qualification
    "period" : { Period }, // Period during which the qualification is valid
    "issuer" : { Reference(Organization) } // Organization that regulates and issues the qualification
  }],
  "communication" : [{ CodeableConcept }] // A language the practitioner is able to use in patient communication
}


 

Practitioner Search Parameters

The following search parameters can be used to query Practitioner resources. Just submit the like so:

https://api.1up.health/fhir/stu3/Practitioner?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
activetextactive
addresstextaddress.line, address.city, address.state, address.country, address.postalCode, address.text
address-citytextaddress.city
address-countrytextaddress.country
address-postalcodetextaddress.postalCode
address-statetextaddress.state
address-usetextaddress.use
communicationtextcommunication
emailtexttelecom.where
familytextname.family
gendertextgender
giventextname.given
identifiertextidentifier
nametextname.family, name.given, name.prefix, name.suffix, name.suffix, name.text
phonetexttelecom.where
phonetictextname
telecomtexttelecom