FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/shr-core-Ratio

Packagehl7.fhir.us.breastcancer
TypeStructureDefinition
Idshr-core-Ratio
FHIR VersionR3
Sourcehttp://hl7.org/fhir/us/breastcancer/http://hl7.org/fhir/us/breastcancer/2018Sep/StructureDefinition-shr-core-Ratio.html
URLhttp://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Ratio
Version0.2.0
Statusdraft
Date2018-08-17T00:00:00+10:00
NameRatioProfile
TitleBC Ratio Profile
Realmus
Authorityhl7
DescriptionA unit of measurement for the quotient of the amount of one entity to another.
PurposeNeed to able to capture ratios for some measurements (titers) and some rates (costs).
TypeRatio
Kindcomplex-type

Resources that use this resource

StructureDefinition
cimi-entity-MedicationBC Medication Profile
cimi-entity-SubstanceBC Substance Profile
cimi-statement-CodedLaboratoryObservationBC CodedLaboratoryObservation Profile
cimi-statement-ComponentOnlyNonLaboratoryObservationBC ComponentOnlyNonLaboratoryObservation Profile
cimi-statement-LaboratoryObservationBC LaboratoryObservation Profile
cimi-statement-NonLaboratoryObservationBC NonLaboratoryObservation Profile
cimi-statement-ObservationBC Observation Profile
cimi-statement-SimpleCodedLaboratoryObservationBC SimpleCodedLaboratoryObservation Profile
cimi-statement-SimpleLaboratoryObservationBC SimpleLaboratoryObservation Profile
oncology-BreastCancerGeneticAnalysisObservationBC BreastCancerGeneticAnalysisObservation Profile
oncology-BreastCancerStageBC BreastCancerStage Profile
oncology-BreastClinicalLymphNodeInvolvementBC BreastClinicalLymphNodeInvolvement Profile
oncology-BreastPathologicalLymphNodeInvolvementBC BreastPathologicalLymphNodeInvolvement Profile
oncology-DCISNuclearGradeBC DCISNuclearGrade Profile
oncology-HER2ReceptorStatusBC HER2ReceptorStatus Profile
oncology-HER2byFISHBC HER2byFISH Profile
oncology-MammaprintRecurrenceScoreBC MammaprintRecurrenceScore Profile
oncology-OncotypeDxDCISRecurrenceScoreBC OncotypeDxDCISRecurrenceScore Profile
oncology-OncotypeDxInvasiveRecurrenceScoreBC OncotypeDxInvasiveRecurrenceScore Profile
oncology-ProsignaRecurrenceScoreBC ProsignaRecurrenceScore Profile
oncology-TumorDimensionsBC TumorDimensions Profile

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

BC Ratio Profile

A unit of measurement for the quotient of the amount of one entity to another.

BC Mapping Summary

shr.core.Ratio maps to Ratio:
  Numerator maps to numerator
  Denominator maps to denominator


Source

{
  "resourceType": "StructureDefinition",
  "id": "shr-core-Ratio",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Ratio",
  "identifier": [
    {
      "system": "http://hl7.org/fhir/us/breastcancer",
      "value": "shr.core.Ratio"
    }
  ],
  "version": "0.2.0",
  "name": "RatioProfile",
  "title": "BC Ratio Profile",
  "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 unit of measurement for the quotient of the amount of one entity to another.",
  "purpose": "Need to able to capture ratios for some measurements (titers) and some rates (costs).",
  "fhirVersion": "3.0.1",
  "mapping": [
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2 Mapping"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "type": "Ratio",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Ratio",
  "derivation": "constraint",
  "snapshot": {
    "element": [
      {
        "id": "Ratio:shr-core-Ratio",
        "path": "Ratio",
        "short": "BC Ratio Profile",
        "definition": "A unit of measurement for the quotient of the amount of one entity to another.",
        "min": 0,
        "max": "*",
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() | (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "Element"
          },
          {
            "key": "rat-1",
            "severity": "error",
            "human": "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present",
            "expression": "(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())",
            "xpath": "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "v2",
            "map": "N/A"
          },
          {
            "identity": "rim",
            "map": "RTO"
          }
        ]
      },
      {
        "id": "Ratio:shr-core-Ratio.id",
        "path": "Ratio.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Ratio:shr-core-Ratio.extension",
        "path": "Ratio.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Additional Content defined by implementations",
        "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
        "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Ratio:shr-core-Ratio.numerator",
        "path": "Ratio.numerator",
        "short": "Numerator value",
        "definition": "The value of the numerator.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Quantity"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".numerator"
          }
        ]
      },
      {
        "id": "Ratio:shr-core-Ratio.denominator",
        "path": "Ratio.denominator",
        "short": "Denominator value",
        "definition": "The value of the denominator.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Quantity"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".denominator"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Ratio:shr-core-Ratio",
        "path": "Ratio",
        "short": "BC Ratio Profile",
        "definition": "A unit of measurement for the quotient of the amount of one entity to another."
      },
      {
        "id": "Ratio:shr-core-Ratio.numerator",
        "path": "Ratio.numerator",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Ratio:shr-core-Ratio.denominator",
        "path": "Ratio.denominator",
        "min": 1,
        "max": "1"
      }
    ]
  }
}