Ratio.profile.json

StructureDefinition for Ratio

{
  "resourceType": "StructureDefinition",
  "id": "Ratio",
  "meta": {
    "lastUpdated": "2016-03-31T08:01:25.570+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/Ratio",
  "name": "Ratio",
  "status": "draft",
  "publisher": "HL7 FHIR Standard",
  "contact": [
    {
      "telecom": [
        {
          "system": "other",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "date": "2016-03-31T08:01:25+11:00",
  "description": "Base StructureDefinition for Ratio Type",
  "requirements": "Need to able to capture ratios for some measurements (titers) and some rates (costs).",
  "fhirVersion": "1.4.0",
  "mapping": [
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    }
  ],
  "kind": "datatype",
  "abstract": false,
  "baseType": "Element",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
  "derivation": "specialization",
  "snapshot": {
    "element": [
      {
        "path": "Ratio",
        "short": "A ratio of two Quantity values - a numerator and a denominator",
        "definition": "A relationship of two Quantity values - expressed as a numerator and a denominator.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Element"
          }
        ],
        "constraint": [
          {
            "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",
            "xpath": "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "N/A"
          },
          {
            "identity": "rim",
            "map": "RTO"
          }
        ]
      },
      {
        "path": "Ratio.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "id"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "Ratio.extension",
        "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.",
        "comments": "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"
          }
        ]
      },
      {
        "path": "Ratio.numerator",
        "short": "Numerator value",
        "definition": "The value of the numerator.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Quantity"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".numerator"
          }
        ]
      },
      {
        "path": "Ratio.denominator",
        "short": "Denominator value",
        "definition": "The value of the denominator.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Quantity"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".denominator"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "Ratio",
        "short": "A ratio of two Quantity values - a numerator and a denominator",
        "definition": "A relationship of two Quantity values - expressed as a numerator and a denominator.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Element"
          }
        ],
        "constraint": [
          {
            "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",
            "xpath": "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "N/A"
          },
          {
            "identity": "rim",
            "map": "RTO"
          }
        ]
      },
      {
        "path": "Ratio.numerator",
        "short": "Numerator value",
        "definition": "The value of the numerator.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Quantity"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".numerator"
          }
        ]
      },
      {
        "path": "Ratio.denominator",
        "short": "Denominator value",
        "definition": "The value of the denominator.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Quantity"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".denominator"
          }
        ]
      }
    ]
  }
}