HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1 (Standard for Trial Use)

This page is part of the Occupational Data for Health (ODH) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

PractitionerModel

{
  "resourceType" : "StructureDefinition",
  "id" : "cimi-entity-Practitioner-model",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>ODH Practitioner Logical Model</b></p>
  <p>A person who practices a healing art.</p>
</div>"
  },
  "url" : "http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Practitioner-model",
  "identifier" : [
    {
      "system" : "http://hl7.org/fhir/us/odh",
      "value" : "cimi.entity.Practitioner"
    }
  ],
  "version" : "0.1.0",
  "name" : "PractitionerModel",
  "title" : "ODH Practitioner Logical Model",
  "status" : "draft",
  "date" : "2018-08-17T00:00:00+10:00",
  "publisher" : "HL7",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://standardhealthrecord.org"
        }
      ]
    }
  ],
  "description" : "A person who practices a healing art.",
  "keyword" : [
    {
      "system" : "http://ncimeta.nci.nih.gov",
      "code" : "C2220264"
    }
  ],
  "kind" : "logical",
  "abstract" : false,
  "type" : "cimi-entity-Practitioner-model",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Element",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "cimi-entity-Practitioner-model",
        "path" : "cimi-entity-Practitioner-model",
        "definition" : "A person who practices a healing art.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-Practitioner-model",
          "min" : 0,
          "max" : "*"
        },
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person",
        "path" : "cimi-entity-Practitioner-model.person",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0027361"
          }
        ],
        "short" : "A person relevant to the health or social situation of the subject (including the person of record him or herself).",
        "definition" : "A person relevant to the health or social situation of the subject (including the person of record him or herself).",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : "http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Person-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.humanName",
        "path" : "cimi-entity-Practitioner-model.person.humanName",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C1547383"
          }
        ],
        "short" : "The CIMI person name, constrained to map correctly to FHIR.",
        "definition" : "The CIMI person name, constrained to map correctly to FHIR.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.humanName",
          "min" : 1,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-HumanName-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.dateOfBirth",
        "path" : "cimi-entity-Practitioner-model.person.dateOfBirth",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C2919018"
          },
          {
            "system" : "http://loinc.org",
            "code" : "21112-8"
          }
        ],
        "short" : "A date of birth or approximate year or period (year or date range), if estimated.",
        "definition" : "A date of birth or approximate year or period (year or date range), if estimated.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.dateOfBirth",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "date"
          },
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-TimePeriod-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.administrativeGender",
        "path" : "cimi-entity-Practitioner-model.person.administrativeGender",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C1550327"
          }
        ],
        "short" : "A gender classification used for administrative purposes. Administrative gender is not necessarily the same as a biological description or a gender identity. This attribute does not include terms related to clinical gender.",
        "definition" : "A gender classification used for administrative purposes. Administrative gender is not necessarily the same as a biological description or a gender identity. This attribute does not include terms related to clinical gender.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.administrativeGender",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "required",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/administrative-gender"
          }
        }
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.address",
        "path" : "cimi-entity-Practitioner-model.person.address",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0682130"
          }
        ],
        "short" : "An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations and which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. (Source: HL7 FHIR).",
        "definition" : "An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations and which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. (Source: HL7 FHIR).",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.address",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-Address-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.headshot",
        "path" : "cimi-entity-Practitioner-model.person.headshot",
        "short" : "A photograph showing a person's face.",
        "definition" : "A photograph showing a person's face.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.headshot",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/cimi-datatypes-Media-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.contactPoint",
        "path" : "cimi-entity-Practitioner-model.person.contactPoint",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C2986441"
          }
        ],
        "short" : "An electronic means of contacting an organization or individual.",
        "definition" : "An electronic means of contacting an organization or individual.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.contactPoint",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-ContactPoint-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.languageUsed",
        "path" : "cimi-entity-Practitioner-model.person.languageUsed",
        "short" : "Language used for communication by a human, either the subject of record, parent, or other involved person.",
        "definition" : "Language used for communication by a human, either the subject of record, parent, or other involved person.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.languageUsed",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-LanguageUsed-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.activeFlag",
        "path" : "cimi-entity-Practitioner-model.person.activeFlag",
        "short" : "If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI.",
        "definition" : "If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.activeFlag",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "boolean"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.maritalStatus",
        "path" : "cimi-entity-Practitioner-model.person.maritalStatus",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0024819"
          }
        ],
        "short" : "The most recent marital status of a person.",
        "definition" : "The most recent marital status of a person.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.maritalStatus",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "extensible",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/marital-status"
          }
        }
      },
      {
        "id" : "cimi-entity-Practitioner-model.nationalProviderIdentifier",
        "path" : "cimi-entity-Practitioner-model.nationalProviderIdentifier",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C1549728"
          }
        ],
        "short" : "A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.",
        "definition" : "A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.nationalProviderIdentifier",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-NationalProviderIdentifier-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.qualification",
        "path" : "cimi-entity-Practitioner-model.qualification",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0037778"
          }
        ],
        "short" : "A right to practice medicine obtained by training and certification.",
        "definition" : "A right to practice medicine obtained by training and certification.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.qualification",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Qualification-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "cimi-entity-Practitioner-model",
        "path" : "cimi-entity-Practitioner-model",
        "definition" : "A person who practices a healing art.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-Practitioner-model",
          "min" : 0,
          "max" : "*"
        },
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person",
        "path" : "cimi-entity-Practitioner-model.person",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0027361"
          }
        ],
        "short" : "A person relevant to the health or social situation of the subject (including the person of record him or herself).",
        "definition" : "A person relevant to the health or social situation of the subject (including the person of record him or herself).",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : "http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Person-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.humanName",
        "path" : "cimi-entity-Practitioner-model.person.humanName",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C1547383"
          }
        ],
        "short" : "The CIMI person name, constrained to map correctly to FHIR.",
        "definition" : "The CIMI person name, constrained to map correctly to FHIR.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.humanName",
          "min" : 1,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-HumanName-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.dateOfBirth",
        "path" : "cimi-entity-Practitioner-model.person.dateOfBirth",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C2919018"
          },
          {
            "system" : "http://loinc.org",
            "code" : "21112-8"
          }
        ],
        "short" : "A date of birth or approximate year or period (year or date range), if estimated.",
        "definition" : "A date of birth or approximate year or period (year or date range), if estimated.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.dateOfBirth",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "date"
          },
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-TimePeriod-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.administrativeGender",
        "path" : "cimi-entity-Practitioner-model.person.administrativeGender",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C1550327"
          }
        ],
        "short" : "A gender classification used for administrative purposes. Administrative gender is not necessarily the same as a biological description or a gender identity. This attribute does not include terms related to clinical gender.",
        "definition" : "A gender classification used for administrative purposes. Administrative gender is not necessarily the same as a biological description or a gender identity. This attribute does not include terms related to clinical gender.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.administrativeGender",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "required",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/administrative-gender"
          }
        }
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.address",
        "path" : "cimi-entity-Practitioner-model.person.address",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0682130"
          }
        ],
        "short" : "An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations and which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. (Source: HL7 FHIR).",
        "definition" : "An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations and which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. (Source: HL7 FHIR).",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.address",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-Address-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.headshot",
        "path" : "cimi-entity-Practitioner-model.person.headshot",
        "short" : "A photograph showing a person's face.",
        "definition" : "A photograph showing a person's face.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.headshot",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/cimi-datatypes-Media-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.contactPoint",
        "path" : "cimi-entity-Practitioner-model.person.contactPoint",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C2986441"
          }
        ],
        "short" : "An electronic means of contacting an organization or individual.",
        "definition" : "An electronic means of contacting an organization or individual.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.contactPoint",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/shr-core-ContactPoint-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.languageUsed",
        "path" : "cimi-entity-Practitioner-model.person.languageUsed",
        "short" : "Language used for communication by a human, either the subject of record, parent, or other involved person.",
        "definition" : "Language used for communication by a human, either the subject of record, parent, or other involved person.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.languageUsed",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-LanguageUsed-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.activeFlag",
        "path" : "cimi-entity-Practitioner-model.person.activeFlag",
        "short" : "If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI.",
        "definition" : "If the ActiveFlag is false, it indicates the record or item is no longer to be used and should generally be hidden for the user in the UI.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.activeFlag",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "boolean"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.person.maritalStatus",
        "path" : "cimi-entity-Practitioner-model.person.maritalStatus",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0024819"
          }
        ],
        "short" : "The most recent marital status of a person.",
        "definition" : "The most recent marital status of a person.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.person.maritalStatus",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "extensible",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/marital-status"
          }
        }
      },
      {
        "id" : "cimi-entity-Practitioner-model.nationalProviderIdentifier",
        "path" : "cimi-entity-Practitioner-model.nationalProviderIdentifier",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C1549728"
          }
        ],
        "short" : "A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.",
        "definition" : "A unique 10 digit number to allow US healthcare providers to identify themselves in a standard way throughout the healthcare industry.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.nationalProviderIdentifier",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-NationalProviderIdentifier-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-entity-Practitioner-model.qualification",
        "path" : "cimi-entity-Practitioner-model.qualification",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0037778"
          }
        ],
        "short" : "A right to practice medicine obtained by training and certification.",
        "definition" : "A right to practice medicine obtained by training and certification.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-entity-Practitioner-model.qualification",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Qualification-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      }
    ]
  }
}