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

This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.1.0: STU 1 Draft) based on FHIR (HL7® FHIR® Standard) R3. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

RatioProfile

 

The official URL for this profile is: 

http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Ratio

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

This profile builds on Ratio.

This profile was published on Sun Apr 01 00:00:00 AEDT 2018 as a draft by The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC).

View the corresponding RatioModel logical model.

Summary

Mandatory: 0 element (2 nested mandatory elements)

BC Mapping Source

This structure represents the following BC mapping definition:

shr.core.Ratio maps to Ratio:
  Numerator maps to numerator
  Denominator maps to denominator
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio BC Ratio Profile
... numerator 1..1
... denominator 1..1

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio I0..*BC Ratio Profile
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... id 0..1stringxml:id (or equivalent in JSON)
... numerator Σ1..1QuantityNumerator value
... denominator Σ1..1QuantityDenominator value

doco Documentation for this format

Summary

Mandatory: 0 element (2 nested mandatory elements)

BC Mapping Source

This structure represents the following BC mapping definition:

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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio BC Ratio Profile
... numerator 1..1
... denominator 1..1

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Ratio I0..*BC Ratio Profile
rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
... id 0..1stringxml:id (or equivalent in JSON)
... numerator Σ1..1QuantityNumerator value
... denominator Σ1..1QuantityDenominator value

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

 

Constraints

IdPathDetailsRequirements
ele-1RatioAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
rat-1RatioNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())