RDC Interoperability Guide
1.0.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

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1string
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueInteger64integer64
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueRatioRangeRatioRange
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueAvailabilityAvailability
valueExtendedContactDetailExtendedContactDetail
valueDosageDosage
valueMetaMeta
valueCodeableReferenceCodeableReference()
valueReferenceReference()
resourceΣ I0..1Resource
partΣ I0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1stringPattern
valueReferenceReference()
resourceΣ I0..0Resource
partΣ I0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1stringPattern
valueStringstring
resourceΣ I0..0Resource
partΣ I0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1stringPattern
valueCodecode
resourceΣ I0..0Resource
partΣ I0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1stringPattern
valueStringstring
resourceΣ I0..0Resource
partΣ I0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1stringPattern
valueCodecode
resourceΣ I0..0Resource
partΣ I0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1stringPattern
valueCodingCoding
resourceΣ I0..0Resource
partΣ I0..0see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1stringPattern
valuePeriodPeriod
resourceΣ I0..0Resource
partΣ I0..0see (parameter)

Parameters
DefinitionThis resource is used to pass information into and back from an operation (whether invoked directly from REST or within a messaging environment). It is not persisted or allowed to be referenced by other resources.
Cardinality0...*
Comments

The parameters that may be used are defined by the OperationDefinition resource.

Mappings
  • rim: Entity. Role, or Act,n/a
  • w5: infrastructure.exchange
  • v2: n/a
Parameters.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typeid
SummaryTrue
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Parameters.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

IETF language tag for a human language

AllLanguages (required)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter
DefinitionA parameter passed to or received from the operation.
Cardinality0...*
TypeBackboneElement
SummaryTrue
SlicingUnordered, Closed, by name(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • inv-1: A parameter must have one and only one of (value, resource, part)
    (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Parameters.parameter.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Parameters.parameter.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Parameters.parameter.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter.value[x]
DefinitionConveys the content if the parameter is a data type.
Cardinality0...1
Typebase64Binary
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter.resource
DefinitionConveys the content if the parameter is a whole resource.
Cardinality0...1
TypeResource
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter.part
DefinitionA named part of a multi-part parameter.
Cardinality0...*
Typesee (parameter)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter:subject
DefinitionReference to Patient resource with personal id.
Cardinality1...1
TypeBackboneElement
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • inv-1: A parameter must have one and only one of (value, resource, part)
    (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter:subject.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Parameters.parameter:subject.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Parameters.parameter:subject.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Parameters.parameter:subject.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern

subject

Parameters.parameter:subject.value[x]
DefinitionConveys the content if the parameter is a data type.
Cardinality1...1
TypeReference()
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter:subject.resource
DefinitionConveys the content if the parameter is a whole resource.
Cardinality0...0
TypeResource
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter:subject.part
DefinitionA named part of a multi-part parameter.
Cardinality0...0
Typesee (parameter)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter:locale
DefinitionText encoding
Cardinality1...1
TypeBackboneElement
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • inv-1: A parameter must have one and only one of (value, resource, part)
    (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter:locale.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Parameters.parameter:locale.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Parameters.parameter:locale.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Parameters.parameter:locale.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern

locale

Parameters.parameter:locale.value[x]
DefinitionConveys the content if the parameter is a data type.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter:locale.resource
DefinitionConveys the content if the parameter is a whole resource.
Cardinality0...0
TypeResource
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter:locale.part
DefinitionA named part of a multi-part parameter.
Cardinality0...0
Typesee (parameter)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter:orientation
DefinitionA parameter passed to or received from the operation.
Cardinality0...1
TypeBackboneElement
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • inv-1: A parameter must have one and only one of (value, resource, part)
    (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter:orientation.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Parameters.parameter:orientation.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Parameters.parameter:orientation.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Parameters.parameter:orientation.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern

orientation

Parameters.parameter:orientation.value[x]
DefinitionConveys the content if the parameter is a data type.
Cardinality1...1
Typecode
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • valueCodeConstraint: The value for orientation must be either 'portrait' or 'landscape'.
    $this = 'portrait' or $this = 'landscape'
Parameters.parameter:orientation.resource
DefinitionConveys the content if the parameter is a whole resource.
Cardinality0...0
TypeResource
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter:orientation.part
DefinitionA named part of a multi-part parameter.
Cardinality0...0
Typesee (parameter)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter:timezone-offset
DefinitionA parameter passed to or received from the operation.
Cardinality0...1
TypeBackboneElement
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • inv-1: A parameter must have one and only one of (value, resource, part)
    (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter:timezone-offset.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Parameters.parameter:timezone-offset.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Parameters.parameter:timezone-offset.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Parameters.parameter:timezone-offset.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern

timezone-offset

Parameters.parameter:timezone-offset.value[x]
DefinitionConveys the content if the parameter is a data type.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter:timezone-offset.resource
DefinitionConveys the content if the parameter is a whole resource.
Cardinality0...0
TypeResource
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter:timezone-offset.part
DefinitionA named part of a multi-part parameter.
Cardinality0...0
Typesee (parameter)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter:time-format
DefinitionA parameter passed to or received from the operation.
Cardinality0...1
TypeBackboneElement
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • inv-1: A parameter must have one and only one of (value, resource, part)
    (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter:time-format.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Parameters.parameter:time-format.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Parameters.parameter:time-format.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Parameters.parameter:time-format.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern

time-format

Parameters.parameter:time-format.value[x]
DefinitionConveys the content if the parameter is a data type.
Cardinality1...1
Typecode
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • valueCodeConstraint: The value for time-format must be either '12H' or '24H'.
    $this = '12H' or $this = '24H'
Parameters.parameter:time-format.resource
DefinitionConveys the content if the parameter is a whole resource.
Cardinality0...0
TypeResource
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter:time-format.part
DefinitionA named part of a multi-part parameter.
Cardinality0...0
Typesee (parameter)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter:unit
DefinitionA parameter passed to or received from the operation.
Cardinality1...1
TypeBackboneElement
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • inv-1: A parameter must have one and only one of (value, resource, part)
    (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter:unit.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Parameters.parameter:unit.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Parameters.parameter:unit.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Parameters.parameter:unit.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern

unit

Parameters.parameter:unit.value[x]
DefinitionConveys the content if the parameter is a data type.
Cardinality1...1
TypeCoding
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • 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
DefinitionConveys the content if the parameter is a whole resource.
Cardinality0...0
TypeResource
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter:unit.part
DefinitionA named part of a multi-part parameter.
Cardinality0...0
Typesee (parameter)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter:effectivePeriod
DefinitionA parameter passed to or received from the operation.
Cardinality1...1
TypeBackboneElement
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • inv-1: A parameter must have one and only one of (value, resource, part)
    (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
Parameters.parameter:effectivePeriod.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Parameters.parameter:effectivePeriod.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Parameters.parameter:effectivePeriod.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
Parameters.parameter:effectivePeriod.name
DefinitionThe name of the parameter (reference to the operation definition).
Cardinality1...1
Typestring
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern

effectivePeriod

Parameters.parameter:effectivePeriod.value[x]
DefinitionConveys the content if the parameter is a data type.
Cardinality1...1
TypePeriod
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Parameters.parameter:effectivePeriod.resource
DefinitionConveys the content if the parameter is a whole resource.
Cardinality0...0
TypeResource
SummaryTrue
Comments

When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to its general resource resolution methods.

Parameters.parameter:effectivePeriod.part
DefinitionA named part of a multi-part parameter.
Cardinality0...0
Typesee (parameter)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
<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 &#39;portrait&#39; or &#39;landscape&#39;." />
                <expression value="$this = &#39;portrait&#39; or $this = &#39;landscape&#39;" />
            </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 &#177;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 &#39;12H&#39; or &#39;24H&#39;." />
                <expression value="$this = &#39;12H&#39; or $this = &#39;24H&#39;" />
            </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 &#39;mg/dL&#39; or &#39;mmol/L&#39;." />
                <expression value="$this.code = &#39;mg/dL&#39; or $this.code = &#39;mmol/L&#39;" />
            </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"
            }
        }
    ]
}