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

HER2toCEP17RatioModel

{
  "resourceType" : "StructureDefinition",
  "id" : "oncology-HER2toCEP17Ratio-model",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC HER2toCEP17Ratio Logical Model</b></p>
  <p>HER2 to CEP17 Ratio (dual probe only)</p>
</div>"
  },
  "url" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/oncology-HER2toCEP17Ratio-model",
  "identifier" : [
    {
      "system" : "http://hl7.org/fhir/us/breastcancer",
      "value" : "oncology.HER2toCEP17Ratio"
    }
  ],
  "version" : "0.2.0",
  "name" : "HER2toCEP17RatioModel",
  "title" : "BC HER2toCEP17Ratio 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" : "HER2 to CEP17 Ratio (dual probe only)",
  "keyword" : [
    {
      "system" : "http://loinc.org",
      "code" : "49683-6",
      "display" : "HER2/CEP17 [Ratio] in Tissue by FISH"
    }
  ],
  "kind" : "logical",
  "abstract" : false,
  "type" : "oncology-HER2toCEP17Ratio-model",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Element",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [
      {
        "id" : "oncology-HER2toCEP17Ratio-model",
        "path" : "oncology-HER2toCEP17Ratio-model",
        "definition" : "HER2 to CEP17 Ratio (dual probe only)",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "oncology-HER2toCEP17Ratio-model",
          "min" : 0,
          "max" : "*"
        },
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "oncology-HER2toCEP17Ratio-model.value",
        "path" : "oncology-HER2toCEP17Ratio-model.value",
        "short" : "Quantity representing hER2 to CEP17 Ratio (dual probe only)",
        "definition" : "Quantity representing hER2 to CEP17 Ratio (dual probe only)",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "oncology-HER2toCEP17Ratio-model.value",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Quantity-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "oncology-HER2toCEP17Ratio-model.topicCode",
        "path" : "oncology-HER2toCEP17Ratio-model.topicCode",
        "short" : "The concept representing the finding or action that is the topic of the statement.",
        "definition" : "The concept representing the finding or action that is the topic of the statement.

For action topics, the TopicCode represents the action being described. For findings, the TopicCode represents the 'question' or property being investigated. For evaluation result findings, the TopicCode contains a concept for an observable entity, such as systolic blood pressure. For assertion findings, the TopicCode contains a code representing the condition, allergy, or other item being asserted. In all cases, the TopicCode describes the topic independent of the context of the action or the finding.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "oncology-HER2toCEP17Ratio-model.topicCode",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "oncology-HER2toCEP17Ratio-model.exceptionValue",
        "path" : "oncology-HER2toCEP17Ratio-model.exceptionValue",
        "short" : "Reason that a value associated with a test or other finding is missing.",
        "definition" : "Reason that a value associated with a test or other finding is missing.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "oncology-HER2toCEP17Ratio-model.exceptionValue",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "extensible",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/data-absent-reason"
          }
        }
      },
      {
        "id" : "oncology-HER2toCEP17Ratio-model.interpretation",
        "path" : "oncology-HER2toCEP17Ratio-model.interpretation",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0420833"
          }
        ],
        "short" : "A clinical interpretation of a finding (applies to both assertions and observation).",
        "definition" : "A clinical interpretation of a finding (applies to both assertions and observation).",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "oncology-HER2toCEP17Ratio-model.interpretation",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "extensible",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/observation-interpretation"
          }
        }
      },
      {
        "id" : "oncology-HER2toCEP17Ratio-model.referenceRange",
        "path" : "oncology-HER2toCEP17Ratio-model.referenceRange",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0883335"
          }
        ],
        "short" : "The usual or acceptable range for a test result.",
        "definition" : "The usual or acceptable range for a test result.",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "oncology-HER2toCEP17Ratio-model.referenceRange",
          "min" : 0,
          "max" : "0"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-topic-ReferenceRange-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "oncology-HER2toCEP17Ratio-model",
        "path" : "oncology-HER2toCEP17Ratio-model",
        "definition" : "HER2 to CEP17 Ratio (dual probe only)",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "oncology-HER2toCEP17Ratio-model",
          "min" : 0,
          "max" : "*"
        },
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "oncology-HER2toCEP17Ratio-model.value",
        "path" : "oncology-HER2toCEP17Ratio-model.value",
        "short" : "Quantity representing hER2 to CEP17 Ratio (dual probe only)",
        "definition" : "Quantity representing hER2 to CEP17 Ratio (dual probe only)",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "oncology-HER2toCEP17Ratio-model.value",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Quantity-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "oncology-HER2toCEP17Ratio-model.topicCode",
        "path" : "oncology-HER2toCEP17Ratio-model.topicCode",
        "short" : "The concept representing the finding or action that is the topic of the statement.",
        "definition" : "The concept representing the finding or action that is the topic of the statement.

For action topics, the TopicCode represents the action being described. For findings, the TopicCode represents the 'question' or property being investigated. For evaluation result findings, the TopicCode contains a concept for an observable entity, such as systolic blood pressure. For assertion findings, the TopicCode contains a code representing the condition, allergy, or other item being asserted. In all cases, the TopicCode describes the topic independent of the context of the action or the finding.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "oncology-HER2toCEP17Ratio-model.topicCode",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      },
      {
        "id" : "oncology-HER2toCEP17Ratio-model.exceptionValue",
        "path" : "oncology-HER2toCEP17Ratio-model.exceptionValue",
        "short" : "Reason that a value associated with a test or other finding is missing.",
        "definition" : "Reason that a value associated with a test or other finding is missing.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "oncology-HER2toCEP17Ratio-model.exceptionValue",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "extensible",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/data-absent-reason"
          }
        }
      },
      {
        "id" : "oncology-HER2toCEP17Ratio-model.interpretation",
        "path" : "oncology-HER2toCEP17Ratio-model.interpretation",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0420833"
          }
        ],
        "short" : "A clinical interpretation of a finding (applies to both assertions and observation).",
        "definition" : "A clinical interpretation of a finding (applies to both assertions and observation).",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "oncology-HER2toCEP17Ratio-model.interpretation",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "Coding"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false,
        "binding" : {
          "strength" : "extensible",
          "valueSetReference" : {
            "reference" : "http://hl7.org/fhir/ValueSet/observation-interpretation"
          }
        }
      },
      {
        "id" : "oncology-HER2toCEP17Ratio-model.referenceRange",
        "path" : "oncology-HER2toCEP17Ratio-model.referenceRange",
        "code" : [
          {
            "system" : "http://ncimeta.nci.nih.gov",
            "code" : "C0883335"
          }
        ],
        "short" : "The usual or acceptable range for a test result.",
        "definition" : "The usual or acceptable range for a test result.",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "oncology-HER2toCEP17Ratio-model.referenceRange",
          "min" : 0,
          "max" : "0"
        },
        "type" : [
          {
            "code" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-topic-ReferenceRange-model"
          }
        ],
        "mustSupport" : false,
        "isModifier" : false,
        "isSummary" : false
      }
    ]
  }
}