HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)

This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions

EncounterModel

{
  "resourceType" : "StructureDefinition",
  "id" : "cimi-encounter-Encounter-model",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC Encounter Logical Model</b></p>
  <p>A description of an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.</p>
</div>"
  },
  "url" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-encounter-Encounter-model",
  "identifier" : [
    {
      "system" : "http://hl7.org/fhir/us/breastcancer",
      "value" : "cimi.encounter.Encounter"
    }
  ],
  "version" : "0.2.0",
  "name" : "EncounterModel",
  "title" : "BC Encounter Logical Model",
  "status" : "draft",
  "date" : "2018-08-17T00:00:00+10:00",
  "publisher" : "The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cic/index.cfm"
        }
      ]
    }
  ],
  "description" : "A description of an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.",
  "kind" : "logical",
  "abstract" : false,
  "type" : "cimi-encounter-Encounter-model",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Element",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "cimi-encounter-Encounter-model",
        "path" : "cimi-encounter-Encounter-model",
        "definition" : "A description of an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-encounter-Encounter-model",
          "min" : 0,
          "max" : "*"
        },
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-encounter-Encounter-model.personOfRecord",
        "path" : "cimi-encounter-Encounter-model.personOfRecord",
        "short" : "The person this entry belongs to.",
        "definition" : "The person this entry belongs to.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-encounter-Encounter-model.personOfRecord",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-core-PersonOfRecord-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-encounter-Encounter-model.encounterType",
        "path" : "cimi-encounter-Encounter-model.encounterType",
        "short" : "Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).",
        "definition" : "Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-encounter-Encounter-model.encounterType",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "extensible",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/v3-ActEncounterCode"
          }
        }
      },
      {
        "id" : "cimi-encounter-Encounter-model.timePeriod",
        "path" : "cimi-encounter-Encounter-model.timePeriod",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C1948053"
          }
        ],
        "short" : "A period of time defined by a start and end time, date, or year.",
        "definition" : "A period of time defined by a start and end time, date, or year.
If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-encounter-Encounter-model.timePeriod",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriod-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-encounter-Encounter-model.status",
        "path" : "cimi-encounter-Encounter-model.status",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0449438"
          }
        ],
        "short" : "The current standing or state.",
        "definition" : "The current standing or state.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-encounter-Encounter-model.status",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "required",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/encounter-status"
          }
        }
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "cimi-encounter-Encounter-model",
        "path" : "cimi-encounter-Encounter-model",
        "definition" : "A description of an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-encounter-Encounter-model",
          "min" : 0,
          "max" : "*"
        },
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-encounter-Encounter-model.personOfRecord",
        "path" : "cimi-encounter-Encounter-model.personOfRecord",
        "short" : "The person this entry belongs to.",
        "definition" : "The person this entry belongs to.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-encounter-Encounter-model.personOfRecord",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-core-PersonOfRecord-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-encounter-Encounter-model.encounterType",
        "path" : "cimi-encounter-Encounter-model.encounterType",
        "short" : "Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).",
        "definition" : "Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "cimi-encounter-Encounter-model.encounterType",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "extensible",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/v3-ActEncounterCode"
          }
        }
      },
      {
        "id" : "cimi-encounter-Encounter-model.timePeriod",
        "path" : "cimi-encounter-Encounter-model.timePeriod",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C1948053"
          }
        ],
        "short" : "A period of time defined by a start and end time, date, or year.",
        "definition" : "A period of time defined by a start and end time, date, or year.
If the start element is missing, the start of the period is not known. If the end element is missing, it means that the period is ongoing, or the start may be in the past, and the end date in the future, which means that period is expected/planned to end at the specified time. The end value includes any matching date/time. For example, the period 2011-05-23 to 2011-05-27 includes all the times from the start of the 23rd May through to the end of the 27th of May.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "cimi-encounter-Encounter-model.timePeriod",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-TimePeriod-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "cimi-encounter-Encounter-model.status",
        "path" : "cimi-encounter-Encounter-model.status",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0449438"
          }
        ],
        "short" : "The current standing or state.",
        "definition" : "The current standing or state.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "cimi-encounter-Encounter-model.status",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "required",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/encounter-status"
          }
        }
      }
    ]
  }
}