RDC Interoperability Guide
1.1.0

Parameters AGP Report

Official URL: https://roche.com/fhir/iop/StructureDefinition/rdc-Parameters-AGP-Report Version: 1.0.0
Parent:

http://hl7.org/fhir/StructureDefinition/Parameters

 Computable Name:

RdcParametersAGPReport

A profile for defining the parameters to be sent as a payload to generate an AGP report for a patient within an organization.

Formal Views of Profile Content

namePattern
valueReferenceReference()
resource..0
part..0
namePattern
valueStringstring
resource..0
part..0
namePattern
valueCodecode
resource..0
part..0
namePattern
valueStringstring
resource..0
part..0
namePattern
valueCodecode
resource..0
part..0
namePattern
valueCodingCoding
resource..0
part..0
namePattern
valuePeriodPeriod
resource..0
part..0

Parameters.parameter
Slicing

Unordered, Closed, by name(Value)

Parameters.parameter:subject
ShortPatient reference
Definition

Reference to Patient resource with personal id.

Cardinality1..1
Must SupportTrue
Parameters.parameter:subject.name
Pattern
subject
Parameters.parameter:subject.value[x]
ShortPatient reference
Cardinality1
TypeReference()
Must SupportTrue
Parameters.parameter:subject.resource
Cardinality..0
Parameters.parameter:subject.part
Cardinality..0
Parameters.parameter:locale
ShortSpecifies the language and locale encoding
Definition

Text encoding

Cardinality1..1
Must SupportTrue
Parameters.parameter:locale.name
Pattern
locale
Parameters.parameter:locale.value[x]
ShortEncoding
Cardinality1
Typestring
Must SupportTrue
Parameters.parameter:locale.resource
Cardinality..0
Parameters.parameter:locale.part
Cardinality..0
Parameters.parameter:orientation
ShortDefines the page orientation of the PDF, such as portrait or landscape (default portrait).
Cardinality..1
Must SupportTrue
Parameters.parameter:orientation.name
Pattern
orientation
Parameters.parameter:orientation.value[x]
Cardinality1
Typecode
Must SupportTrue
Constraints
  • valueCodeConstraint: The value for orientation must be either 'portrait' or 'landscape'.
    $this = 'portrait' or $this = 'landscape'
Parameters.parameter:orientation.resource
Cardinality..0
Parameters.parameter:orientation.part
Cardinality..0
Parameters.parameter:timezone-offset
ShortUTC offset for a time zone in ±hh:mm format (default will be server timezone).
Cardinality..1
Must SupportTrue
Parameters.parameter:timezone-offset.name
Pattern
timezone-offset
Parameters.parameter:timezone-offset.value[x]
Cardinality1
Typestring
Must SupportTrue
Parameters.parameter:timezone-offset.resource
Cardinality..0
Parameters.parameter:timezone-offset.part
Cardinality..0
Parameters.parameter:time-format
ShortSpecifies the time format, such as 12H for 12-hour or 24H for 24-hour format (default 24H).
Cardinality..1
Must SupportTrue
Parameters.parameter:time-format.name
Pattern
time-format
Parameters.parameter:time-format.value[x]
Cardinality1
Typecode
Must SupportTrue
Constraints
  • valueCodeConstraint: The value for time-format must be either '12H' or '24H'.
    $this = '12H' or $this = '24H'
Parameters.parameter:time-format.resource
Cardinality..0
Parameters.parameter:time-format.part
Cardinality..0
Parameters.parameter:unit
ShortSpecifies the unit mg/dL|mmol/L.
Cardinality1..1
Must SupportTrue
Parameters.parameter:unit.name
Pattern
unit
Parameters.parameter:unit.value[x]
Cardinality1
TypeCoding
Must SupportTrue
Constraints
  • valueCodeConstraint: The value for unit must be either 'mg/dL' or 'mmol/L'.
    $this.code = 'mg/dL' or $this.code = 'mmol/L'
Parameters.parameter:unit.resource
Cardinality..0
Parameters.parameter:unit.part
Cardinality..0
Parameters.parameter:effectivePeriod
ShortRepresents the start and end dates defining the period.The maximum Period for the generation of report is 14 days.
Cardinality1..1
Must SupportTrue
Parameters.parameter:effectivePeriod.name
Pattern
effectivePeriod
Parameters.parameter:effectivePeriod.value[x]
Cardinality1
TypePeriod
Must SupportTrue
Parameters.parameter:effectivePeriod.resource
Cardinality..0
Parameters.parameter:effectivePeriod.part
Cardinality..0
  • rdc-Parameters-AGP-Report-examples
    • <StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="rdc-Parameters-AGP-Report" />
    <url value="https://roche.com/fhir/iop/StructureDefinition/rdc-Parameters-AGP-Report" />
    <name value="RdcParametersAGPReport" />
    <title value="RDC Parameters AGP Report" />
    <status value="active" />
    <experimental value="false" />
    <description value="A profile for defining the parameters to be sent as a payload to generate an AGP report for a patient within an organization." />
    <fhirVersion value="5.0.0" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Parameters" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Parameters" />
    <derivation value="constraint" />
    <differential>
    <element id="Parameters.parameter">
    <path value="Parameters.parameter" />
    <slicing>
    <discriminator>
    <type value="value" />
    <path value="name" />
    </discriminator>
    <rules value="closed" />
    </slicing>
    </element>
    <element id="Parameters.parameter:subject">
    <path value="Parameters.parameter" />
    <sliceName value="subject" />
    <short value="Patient reference" />
    <definition value="Reference to Patient resource with personal id." />
    <min value="1" />
    <max value="1" />
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:subject.name">
    <path value="Parameters.parameter.name" />
    <patternString value="subject" />
    </element>
    <element id="Parameters.parameter:subject.value[x]">
    <path value="Parameters.parameter.value[x]" />
    <short value="Patient reference" />
    <min value="1" />
    <type>
    <code value="Reference" />
    </type>
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:subject.resource">
    <path value="Parameters.parameter.resource" />
    <max value="0" />
    </element>
    <element id="Parameters.parameter:subject.part">
    <path value="Parameters.parameter.part" />
    <max value="0" />
    </element>
    <element id="Parameters.parameter:locale">
    <path value="Parameters.parameter" />
    <sliceName value="locale" />
    <short value="Specifies the language and locale encoding" />
    <definition value="Text encoding" />
    <min value="1" />
    <max value="1" />
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:locale.name">
    <path value="Parameters.parameter.name" />
    <patternString value="locale" />
    </element>
    <element id="Parameters.parameter:locale.value[x]">
    <path value="Parameters.parameter.value[x]" />
    <short value="Encoding" />
    <min value="1" />
    <type>
    <code value="string" />
    </type>
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:locale.resource">
    <path value="Parameters.parameter.resource" />
    <max value="0" />
    </element>
    <element id="Parameters.parameter:locale.part">
    <path value="Parameters.parameter.part" />
    <max value="0" />
    </element>
    <element id="Parameters.parameter:orientation">
    <path value="Parameters.parameter" />
    <sliceName value="orientation" />
    <short value="Defines the page orientation of the PDF, such as portrait or landscape (default portrait)." />
    <max value="1" />
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:orientation.name">
    <path value="Parameters.parameter.name" />
    <patternString value="orientation" />
    </element>
    <element id="Parameters.parameter:orientation.value[x]">
    <path value="Parameters.parameter.value[x]" />
    <min value="1" />
    <type>
    <code value="code" />
    </type>
    <constraint>
    <key value="valueCodeConstraint" />
    <severity value="error" />
    <human value="The value for orientation must be either 'portrait' or 'landscape'." />
    <expression value="$this = 'portrait' or $this = 'landscape'" />
    </constraint>
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:orientation.resource">
    <path value="Parameters.parameter.resource" />
    <max value="0" />
    </element>
    <element id="Parameters.parameter:orientation.part">
    <path value="Parameters.parameter.part" />
    <max value="0" />
    </element>
    <element id="Parameters.parameter:timezone-offset">
    <path value="Parameters.parameter" />
    <sliceName value="timezone-offset" />
    <short value="UTC offset for a time zone in ±hh:mm format (default will be server timezone)." />
    <max value="1" />
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:timezone-offset.name">
    <path value="Parameters.parameter.name" />
    <patternString value="timezone-offset" />
    </element>
    <element id="Parameters.parameter:timezone-offset.value[x]">
    <path value="Parameters.parameter.value[x]" />
    <min value="1" />
    <type>
    <code value="string" />
    </type>
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:timezone-offset.resource">
    <path value="Parameters.parameter.resource" />
    <max value="0" />
    </element>
    <element id="Parameters.parameter:timezone-offset.part">
    <path value="Parameters.parameter.part" />
    <max value="0" />
    </element>
    <element id="Parameters.parameter:time-format">
    <path value="Parameters.parameter" />
    <sliceName value="time-format" />
    <short value="Specifies the time format, such as 12H for 12-hour or 24H for 24-hour format (default 24H)." />
    <max value="1" />
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:time-format.name">
    <path value="Parameters.parameter.name" />
    <patternString value="time-format" />
    </element>
    <element id="Parameters.parameter:time-format.value[x]">
    <path value="Parameters.parameter.value[x]" />
    <min value="1" />
    <type>
    <code value="code" />
    </type>
    <constraint>
    <key value="valueCodeConstraint" />
    <severity value="error" />
    <human value="The value for time-format must be either '12H' or '24H'." />
    <expression value="$this = '12H' or $this = '24H'" />
    </constraint>
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:time-format.resource">
    <path value="Parameters.parameter.resource" />
    <max value="0" />
    </element>
    <element id="Parameters.parameter:time-format.part">
    <path value="Parameters.parameter.part" />
    <max value="0" />
    </element>
    <element id="Parameters.parameter:unit">
    <path value="Parameters.parameter" />
    <sliceName value="unit" />
    <short value="Specifies the unit mg/dL|mmol/L." />
    <min value="1" />
    <max value="1" />
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:unit.name">
    <path value="Parameters.parameter.name" />
    <patternString value="unit" />
    </element>
    <element id="Parameters.parameter:unit.value[x]">
    <path value="Parameters.parameter.value[x]" />
    <min value="1" />
    <type>
    <code value="Coding" />
    </type>
    <constraint>
    <key value="valueCodeConstraint" />
    <severity value="error" />
    <human value="The value for unit must be either 'mg/dL' or 'mmol/L'." />
    <expression value="$this.code = 'mg/dL' or $this.code = 'mmol/L'" />
    </constraint>
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:unit.resource">
    <path value="Parameters.parameter.resource" />
    <max value="0" />
    </element>
    <element id="Parameters.parameter:unit.part">
    <path value="Parameters.parameter.part" />
    <max value="0" />
    </element>
    <element id="Parameters.parameter:effectivePeriod">
    <path value="Parameters.parameter" />
    <sliceName value="effectivePeriod" />
    <short value="Represents the start and end dates defining the period.The maximum Period for the generation of report is 14 days." />
    <min value="1" />
    <max value="1" />
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:effectivePeriod.name">
    <path value="Parameters.parameter.name" />
    <patternString value="effectivePeriod" />
    </element>
    <element id="Parameters.parameter:effectivePeriod.value[x]">
    <path value="Parameters.parameter.value[x]" />
    <min value="1" />
    <type>
    <code value="Period" />
    </type>
    <mustSupport value="true" />
    </element>
    <element id="Parameters.parameter:effectivePeriod.resource">
    <path value="Parameters.parameter.resource" />
    <max value="0" />
    </element>
    <element id="Parameters.parameter:effectivePeriod.part">
    <path value="Parameters.parameter.part" />
    <max value="0" />
    </element>
    </differential>
    </StructureDefinition>
    {
    "resourceType": "StructureDefinition",
    "id": "rdc-Parameters-AGP-Report",
    "url": "https://roche.com/fhir/iop/StructureDefinition/rdc-Parameters-AGP-Report",
    "name": "RdcParametersAGPReport",
    "title": "RDC Parameters AGP Report",
    "status": "active",
    "experimental": false,
    "description": "A profile for defining the parameters to be sent as a payload to generate an AGP report for a patient within an organization.",
    "fhirVersion": "5.0.0",
    "kind": "resource",
    "abstract": false,
    "type": "Parameters",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Parameters",
    "derivation": "constraint",
    "differential": {
    "element": [
    {
    "id": "Parameters.parameter",
    "path": "Parameters.parameter",
    "slicing": {
    "discriminator": [
    {
    "type": "value",
    "path": "name"
    }
    ],
    "rules": "closed"
    }
    },
    {
    "id": "Parameters.parameter:subject",
    "path": "Parameters.parameter",
    "sliceName": "subject",
    "short": "Patient reference",
    "definition": "Reference to Patient resource with personal id.",
    "min": 1,
    "max": "1",
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:subject.name",
    "path": "Parameters.parameter.name",
    "patternString": "subject"
    },
    {
    "id": "Parameters.parameter:subject.value[x]",
    "path": "Parameters.parameter.value[x]",
    "short": "Patient reference",
    "min": 1,
    "type": [
    {
    "code": "Reference"
    }
    ],
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:subject.resource",
    "path": "Parameters.parameter.resource",
    "max": "0"
    },
    {
    "id": "Parameters.parameter:subject.part",
    "path": "Parameters.parameter.part",
    "max": "0"
    },
    {
    "id": "Parameters.parameter:locale",
    "path": "Parameters.parameter",
    "sliceName": "locale",
    "short": "Specifies the language and locale encoding",
    "definition": "Text encoding",
    "min": 1,
    "max": "1",
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:locale.name",
    "path": "Parameters.parameter.name",
    "patternString": "locale"
    },
    {
    "id": "Parameters.parameter:locale.value[x]",
    "path": "Parameters.parameter.value[x]",
    "short": "Encoding",
    "min": 1,
    "type": [
    {
    "code": "string"
    }
    ],
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:locale.resource",
    "path": "Parameters.parameter.resource",
    "max": "0"
    },
    {
    "id": "Parameters.parameter:locale.part",
    "path": "Parameters.parameter.part",
    "max": "0"
    },
    {
    "id": "Parameters.parameter:orientation",
    "path": "Parameters.parameter",
    "sliceName": "orientation",
    "short": "Defines the page orientation of the PDF, such as portrait or landscape (default portrait).",
    "max": "1",
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:orientation.name",
    "path": "Parameters.parameter.name",
    "patternString": "orientation"
    },
    {
    "id": "Parameters.parameter:orientation.value[x]",
    "path": "Parameters.parameter.value[x]",
    "min": 1,
    "type": [
    {
    "code": "code"
    }
    ],
    "constraint": [
    {
    "key": "valueCodeConstraint",
    "severity": "error",
    "human": "The value for orientation must be either 'portrait' or 'landscape'.",
    "expression": "$this = 'portrait' or $this = 'landscape'"
    }
    ],
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:orientation.resource",
    "path": "Parameters.parameter.resource",
    "max": "0"
    },
    {
    "id": "Parameters.parameter:orientation.part",
    "path": "Parameters.parameter.part",
    "max": "0"
    },
    {
    "id": "Parameters.parameter:timezone-offset",
    "path": "Parameters.parameter",
    "sliceName": "timezone-offset",
    "short": "UTC offset for a time zone in ±hh:mm format (default will be server timezone).",
    "max": "1",
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:timezone-offset.name",
    "path": "Parameters.parameter.name",
    "patternString": "timezone-offset"
    },
    {
    "id": "Parameters.parameter:timezone-offset.value[x]",
    "path": "Parameters.parameter.value[x]",
    "min": 1,
    "type": [
    {
    "code": "string"
    }
    ],
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:timezone-offset.resource",
    "path": "Parameters.parameter.resource",
    "max": "0"
    },
    {
    "id": "Parameters.parameter:timezone-offset.part",
    "path": "Parameters.parameter.part",
    "max": "0"
    },
    {
    "id": "Parameters.parameter:time-format",
    "path": "Parameters.parameter",
    "sliceName": "time-format",
    "short": "Specifies the time format, such as 12H for 12-hour or 24H for 24-hour format (default 24H).",
    "max": "1",
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:time-format.name",
    "path": "Parameters.parameter.name",
    "patternString": "time-format"
    },
    {
    "id": "Parameters.parameter:time-format.value[x]",
    "path": "Parameters.parameter.value[x]",
    "min": 1,
    "type": [
    {
    "code": "code"
    }
    ],
    "constraint": [
    {
    "key": "valueCodeConstraint",
    "severity": "error",
    "human": "The value for time-format must be either '12H' or '24H'.",
    "expression": "$this = '12H' or $this = '24H'"
    }
    ],
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:time-format.resource",
    "path": "Parameters.parameter.resource",
    "max": "0"
    },
    {
    "id": "Parameters.parameter:time-format.part",
    "path": "Parameters.parameter.part",
    "max": "0"
    },
    {
    "id": "Parameters.parameter:unit",
    "path": "Parameters.parameter",
    "sliceName": "unit",
    "short": "Specifies the unit mg/dL|mmol/L.",
    "min": 1,
    "max": "1",
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:unit.name",
    "path": "Parameters.parameter.name",
    "patternString": "unit"
    },
    {
    "id": "Parameters.parameter:unit.value[x]",
    "path": "Parameters.parameter.value[x]",
    "min": 1,
    "type": [
    {
    "code": "Coding"
    }
    ],
    "constraint": [
    {
    "key": "valueCodeConstraint",
    "severity": "error",
    "human": "The value for unit must be either 'mg/dL' or 'mmol/L'.",
    "expression": "$this.code = 'mg/dL' or $this.code = 'mmol/L'"
    }
    ],
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:unit.resource",
    "path": "Parameters.parameter.resource",
    "max": "0"
    },
    {
    "id": "Parameters.parameter:unit.part",
    "path": "Parameters.parameter.part",
    "max": "0"
    },
    {
    "id": "Parameters.parameter:effectivePeriod",
    "path": "Parameters.parameter",
    "sliceName": "effectivePeriod",
    "short": "Represents the start and end dates defining the period.The maximum Period for the generation of report is 14 days.",
    "min": 1,
    "max": "1",
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:effectivePeriod.name",
    "path": "Parameters.parameter.name",
    "patternString": "effectivePeriod"
    },
    {
    "id": "Parameters.parameter:effectivePeriod.value[x]",
    "path": "Parameters.parameter.value[x]",
    "min": 1,
    "type": [
    {
    "code": "Period"
    }
    ],
    "mustSupport": true
    },
    {
    "id": "Parameters.parameter:effectivePeriod.resource",
    "path": "Parameters.parameter.resource",
    "max": "0"
    },
    {
    "id": "Parameters.parameter:effectivePeriod.part",
    "path": "Parameters.parameter.part",
    "max": "0"
    }
    ]
    }
    }

    Attribute description :

    Attributes Description Terminology reference
    subject Patient reference Patient/<ref> for which the AGP report to be generated. Reference identifying the patient associated to the AGP Report.
    locale Specifies the language and locale encoding
    orientation Defines the page orientation of the PDF, such as portrait or landscape (default portrait).
    timezone-offset UTC offset for a time zone in ±hh:mm format (default will be server timezone).
    time-format Specifies the time format, such as 12H for 12-hour or 24H for 24-hour format (default 24H).
    unit Specifies the unit mg/dL or mmol/L.
    effectivePeriod Represents the start and end a pair of dates defining the period. The maximum Period for the generation of report is 14 days.

    Resource examples

    Parameters AGP Report

    Example of the parameters to be sent as a payload to generate an AGP report for patient within organization having id 123

    {
    "resourceType": "Parameters",
    "id": "1418726f-ca88-4799-9f2f-d58988b4fdee",
    "meta": {
        "versionId": "1669630588484",
        "lastUpdated": "2022-11-28T10:16:28.484+00:00"
    },
    "parameter": [
        {
            "name": "subject",
            "valueReference": {
                "reference": "Patient/123"
            }
        },
        {
            "name": "locale",
            "valueString": "en-US"
        },
        {
            "name": "orientation",
            "valueCode": "portrait"
        },
        {
            "name": "timezone-offset",
            "valueString": "-03:00"
        },
        {
            "name": "time-format",
            "valueCode": "24H"
        },
        {
            "name": "unit",
            "valueCoding": {
                "system": "http://unitsofmeasure.org",
                "code": "mg/dL",
                "display": "mg/dL"
            }
        },
        {
            "name": "effectivePeriod",
            "valuePeriod": {
                "start": "2011-05-23",
                "end": "2011-05-27"
            }
        }
    ]
}

    Example with minimum payload:

    {
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "subject",
            "valueReference": {
                "reference": "Patient/123"
            }
        },
        {
            "name": "locale",
            "valueString": "en-US"
        },
        {
            "name": "unit",
            "valueCoding": {
                "system": "http://unitsofmeasure.org",
                "code": "mg/dL",
                "display": "mg/dL"
            }
        },
        {
            "name": "effectivePeriod",
            "valuePeriod": {
                "start": "2011-05-23",
                "end": "2011-05-27"
            }
        }
    ]
}