Parameters Report
Official URL: https://roche.com/fhir/iop/StructureDefinition/rdc-Parameters-AGP-Report | Version: 1.0.0 | |||
Parent: |
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
RdcParametersAGPReport (Parameters) | Parameters | ||
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
parameter | Σ C | 0..* | BackboneElement |
(All Slices) | |||
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
name | Σ | 1..1 | string |
value[x] | Σ C | 0..1 | |
valueBase64Binary | base64Binary | ||
valueBoolean | boolean | ||
valueCanonical | canonical() | ||
valueCode | code | ||
valueDate | date | ||
valueDateTime | dateTime | ||
valueDecimal | decimal | ||
valueId | id | ||
valueInstant | instant | ||
valueInteger | integer | ||
valueInteger64 | integer64 | ||
valueMarkdown | markdown | ||
valueOid | oid | ||
valuePositiveInt | positiveInt | ||
valueString | string | ||
valueTime | time | ||
valueUnsignedInt | unsignedInt | ||
valueUri | uri | ||
valueUrl | url | ||
valueUuid | uuid | ||
valueAddress | Address | ||
valueAge | Age | ||
valueAnnotation | Annotation | ||
valueAttachment | Attachment | ||
valueCodeableConcept | CodeableConcept | ||
valueCoding | Coding | ||
valueContactPoint | ContactPoint | ||
valueCount | Count | ||
valueDistance | Distance | ||
valueDuration | Duration | ||
valueHumanName | HumanName | ||
valueIdentifier | Identifier | ||
valueMoney | Money | ||
valuePeriod | Period | ||
valueQuantity | Quantity | ||
valueRange | Range | ||
valueRatio | Ratio | ||
valueRatioRange | RatioRange | ||
valueSampledData | SampledData | ||
valueSignature | Signature | ||
valueTiming | Timing | ||
valueContactDetail | ContactDetail | ||
valueDataRequirement | DataRequirement | ||
valueExpression | Expression | ||
valueParameterDefinition | ParameterDefinition | ||
valueRelatedArtifact | RelatedArtifact | ||
valueTriggerDefinition | TriggerDefinition | ||
valueUsageContext | UsageContext | ||
valueAvailability | Availability | ||
valueExtendedContactDetail | ExtendedContactDetail | ||
valueDosage | Dosage | ||
valueMeta | Meta | ||
valueCodeableReference | CodeableReference() | ||
valueReference | Reference() | ||
resource | Σ C | 0..1 | Resource |
part | Σ C | 0..* | see (parameter) |
reportType | S Σ C | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
name | Σ | 1..1 | stringPattern |
value[x] | S Σ C | 1..1 | |
valueString | string | ||
resource | Σ C | 0..0 | Resource |
part | Σ C | 0..0 | see (parameter) |
subject | S Σ C | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
name | Σ | 1..1 | stringPattern |
value[x] | S Σ C | 1..1 | |
valueReference | Reference() | ||
resource | Σ C | 0..0 | Resource |
part | Σ C | 0..0 | see (parameter) |
locale | S Σ C | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
name | Σ | 1..1 | stringPattern |
value[x] | S Σ C | 1..1 | |
valueString | string | ||
resource | Σ C | 0..0 | Resource |
part | Σ C | 0..0 | see (parameter) |
orientation | S Σ C | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
name | Σ | 1..1 | stringPattern |
value[x] | S Σ C | 1..1 | |
valueCode | code | ||
resource | Σ C | 0..0 | Resource |
part | Σ C | 0..0 | see (parameter) |
timezone-offset | S Σ C | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
name | Σ | 1..1 | stringPattern |
value[x] | S Σ C | 1..1 | |
valueString | string | ||
resource | Σ C | 0..0 | Resource |
part | Σ C | 0..0 | see (parameter) |
time-format | S Σ C | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
name | Σ | 1..1 | stringPattern |
value[x] | S Σ C | 1..1 | |
valueCode | code | ||
resource | Σ C | 0..0 | Resource |
part | Σ C | 0..0 | see (parameter) |
unit | S Σ C | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
name | Σ | 1..1 | stringPattern |
value[x] | S Σ C | 1..1 | |
valueCoding | Coding | ||
resource | Σ C | 0..0 | Resource |
part | Σ C | 0..0 | see (parameter) |
effectivePeriod | S Σ C | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
name | Σ | 1..1 | stringPattern |
value[x] | S Σ C | 1..1 | |
valuePeriod | Period | ||
resource | Σ C | 0..0 | Resource |
part | Σ C | 0..0 | see (parameter) |
Parameters | |
Short | Operation Request or Response |
Definition | This 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. |
Cardinality | 0..* |
Comments | The parameters that may be used are defined by the OperationDefinition resource. |
Mappings |
|
Parameters.id | |
Short | Logical id of this artifact |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0..1 |
Type | id |
Summary | True |
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 | |
Short | Metadata about the resource |
Definition | The 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. |
Cardinality | 0..1 |
Type | Meta |
Summary | True |
Constraints |
|
Parameters.implicitRules | |
Short | A set of rules under which this content was created |
Definition | A 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. |
Cardinality | 0..1 |
Type | uri |
Modifier | True |
Summary | True |
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. |
Constraints |
|
Parameters.language | |
Short | Language of the resource content |
Definition | The base language in which the resource is written. |
Cardinality | 0..1 |
Type | code |
Binding | IETF language tag for a human language |
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). |
Constraints |
|
Parameters.parameter | |
Short | Operation Parameter |
Definition | A parameter passed to or received from the operation. |
Cardinality | 0..* |
Type | BackboneElement |
Summary | True |
Slicing | Unordered, Closed, by name(Value) |
Constraints |
|
Parameters.parameter.id | |
Short | Unique id for inter-element referencing |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0..1 |
Type | string |
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
Mappings |
|
Parameters.parameter.extension | |
Short | Additional content defined by implementations |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Cardinality | 0..* |
Type | Extension |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter.modifierExtension | |
Short | Extensions that cannot be ignored even if unrecognized |
Definition | May 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). |
Cardinality | 0..* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter.name | |
Short | Name from the definition |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1..1 |
Type | string |
Summary | True |
Constraints |
|
Parameters.parameter.value[x] | |
Short | If parameter is a data type |
Definition | Conveys the content if the parameter is a data type. |
Cardinality | 0..1 |
Type | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference(), Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference(), SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter.resource | |
Short | If parameter is a whole resource |
Definition | Conveys the content if the parameter is a whole resource. |
Cardinality | 0..1 |
Type | Resource |
Summary | True |
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. |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Parameters.parameter.part | |
Short | Named part of a multi-part parameter |
Definition | A named part of a multi-part parameter. |
Cardinality | 0..* |
Type | see (parameter) |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:reportType | |
Short | Specifies the type of the report for request |
Definition | Text encoding |
Cardinality | 0..1 |
Type | BackboneElement |
Must Support | True |
Summary | True |
Constraints |
|
Parameters.parameter:reportType.id | |
Short | Unique id for inter-element referencing |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0..1 |
Type | string |
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
Mappings |
|
Parameters.parameter:reportType.extension | |
Short | Additional content defined by implementations |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Cardinality | 0..* |
Type | Extension |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:reportType.modifierExtension | |
Short | Extensions that cannot be ignored even if unrecognized |
Definition | May 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). |
Cardinality | 0..* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:reportType.name | |
Short | Name from the definition |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1..1 |
Type | string |
Summary | True |
Constraints |
|
Pattern | reportType |
Parameters.parameter:reportType.value[x] | |
Short | Encoding |
Definition | Conveys the content if the parameter is a data type. |
Cardinality | 1..1 |
Type | string |
Must Support | True |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:reportType.resource | |
Short | If parameter is a whole resource |
Definition | Conveys the content if the parameter is a whole resource. |
Cardinality | 0..0 |
Type | Resource |
Summary | True |
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. |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Parameters.parameter:reportType.part | |
Short | Named part of a multi-part parameter |
Definition | A named part of a multi-part parameter. |
Cardinality | 0..0 |
Type | see (parameter) |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:subject | |
Short | Patient reference |
Definition | Reference to Patient resource with personal id. |
Cardinality | 1..1 |
Type | BackboneElement |
Must Support | True |
Summary | True |
Constraints |
|
Parameters.parameter:subject.id | |
Short | Unique id for inter-element referencing |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0..1 |
Type | string |
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
Mappings |
|
Parameters.parameter:subject.extension | |
Short | Additional content defined by implementations |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Cardinality | 0..* |
Type | Extension |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:subject.modifierExtension | |
Short | Extensions that cannot be ignored even if unrecognized |
Definition | May 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). |
Cardinality | 0..* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:subject.name | |
Short | Name from the definition |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1..1 |
Type | string |
Summary | True |
Constraints |
|
Pattern | subject |
Parameters.parameter:subject.value[x] | |
Short | Patient reference |
Definition | Conveys the content if the parameter is a data type. |
Cardinality | 1..1 |
Type | Reference() |
Must Support | True |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:subject.resource | |
Short | If parameter is a whole resource |
Definition | Conveys the content if the parameter is a whole resource. |
Cardinality | 0..0 |
Type | Resource |
Summary | True |
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. |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Parameters.parameter:subject.part | |
Short | Named part of a multi-part parameter |
Definition | A named part of a multi-part parameter. |
Cardinality | 0..0 |
Type | see (parameter) |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:locale | |
Short | Specifies the language and locale encoding |
Definition | Text encoding |
Cardinality | 1..1 |
Type | BackboneElement |
Must Support | True |
Summary | True |
Constraints |
|
Parameters.parameter:locale.id | |
Short | Unique id for inter-element referencing |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0..1 |
Type | string |
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
Mappings |
|
Parameters.parameter:locale.extension | |
Short | Additional content defined by implementations |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Cardinality | 0..* |
Type | Extension |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:locale.modifierExtension | |
Short | Extensions that cannot be ignored even if unrecognized |
Definition | May 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). |
Cardinality | 0..* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:locale.name | |
Short | Name from the definition |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1..1 |
Type | string |
Summary | True |
Constraints |
|
Pattern | locale |
Parameters.parameter:locale.value[x] | |
Short | Encoding |
Definition | Conveys the content if the parameter is a data type. |
Cardinality | 1..1 |
Type | string |
Must Support | True |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:locale.resource | |
Short | If parameter is a whole resource |
Definition | Conveys the content if the parameter is a whole resource. |
Cardinality | 0..0 |
Type | Resource |
Summary | True |
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. |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Parameters.parameter:locale.part | |
Short | Named part of a multi-part parameter |
Definition | A named part of a multi-part parameter. |
Cardinality | 0..0 |
Type | see (parameter) |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:orientation | |
Short | Defines the page orientation of the PDF, such as portrait or landscape (default portrait). |
Definition | A parameter passed to or received from the operation. |
Cardinality | 0..1 |
Type | BackboneElement |
Must Support | True |
Summary | True |
Constraints |
|
Parameters.parameter:orientation.id | |
Short | Unique id for inter-element referencing |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0..1 |
Type | string |
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
Mappings |
|
Parameters.parameter:orientation.extension | |
Short | Additional content defined by implementations |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Cardinality | 0..* |
Type | Extension |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:orientation.modifierExtension | |
Short | Extensions that cannot be ignored even if unrecognized |
Definition | May 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). |
Cardinality | 0..* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:orientation.name | |
Short | Name from the definition |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1..1 |
Type | string |
Summary | True |
Constraints |
|
Pattern | orientation |
Parameters.parameter:orientation.value[x] | |
Short | If parameter is a data type |
Definition | Conveys the content if the parameter is a data type. |
Cardinality | 1..1 |
Type | code |
Must Support | True |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:orientation.resource | |
Short | If parameter is a whole resource |
Definition | Conveys the content if the parameter is a whole resource. |
Cardinality | 0..0 |
Type | Resource |
Summary | True |
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. |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Parameters.parameter:orientation.part | |
Short | Named part of a multi-part parameter |
Definition | A named part of a multi-part parameter. |
Cardinality | 0..0 |
Type | see (parameter) |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:timezone-offset | |
Short | UTC offset for a time zone in ±hh:mm format (default will be server timezone). |
Definition | A parameter passed to or received from the operation. |
Cardinality | 0..1 |
Type | BackboneElement |
Must Support | True |
Summary | True |
Constraints |
|
Parameters.parameter:timezone-offset.id | |
Short | Unique id for inter-element referencing |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0..1 |
Type | string |
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
Mappings |
|
Parameters.parameter:timezone-offset.extension | |
Short | Additional content defined by implementations |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Cardinality | 0..* |
Type | Extension |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:timezone-offset.modifierExtension | |
Short | Extensions that cannot be ignored even if unrecognized |
Definition | May 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). |
Cardinality | 0..* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:timezone-offset.name | |
Short | Name from the definition |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1..1 |
Type | string |
Summary | True |
Constraints |
|
Pattern | timezone-offset |
Parameters.parameter:timezone-offset.value[x] | |
Short | If parameter is a data type |
Definition | Conveys the content if the parameter is a data type. |
Cardinality | 1..1 |
Type | string |
Must Support | True |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:timezone-offset.resource | |
Short | If parameter is a whole resource |
Definition | Conveys the content if the parameter is a whole resource. |
Cardinality | 0..0 |
Type | Resource |
Summary | True |
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. |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Parameters.parameter:timezone-offset.part | |
Short | Named part of a multi-part parameter |
Definition | A named part of a multi-part parameter. |
Cardinality | 0..0 |
Type | see (parameter) |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:time-format | |
Short | Specifies the time format, such as 12H for 12-hour or 24H for 24-hour format (default 24H). |
Definition | A parameter passed to or received from the operation. |
Cardinality | 0..1 |
Type | BackboneElement |
Must Support | True |
Summary | True |
Constraints |
|
Parameters.parameter:time-format.id | |
Short | Unique id for inter-element referencing |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0..1 |
Type | string |
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
Mappings |
|
Parameters.parameter:time-format.extension | |
Short | Additional content defined by implementations |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Cardinality | 0..* |
Type | Extension |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:time-format.modifierExtension | |
Short | Extensions that cannot be ignored even if unrecognized |
Definition | May 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). |
Cardinality | 0..* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:time-format.name | |
Short | Name from the definition |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1..1 |
Type | string |
Summary | True |
Constraints |
|
Pattern | time-format |
Parameters.parameter:time-format.value[x] | |
Short | If parameter is a data type |
Definition | Conveys the content if the parameter is a data type. |
Cardinality | 1..1 |
Type | code |
Must Support | True |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:time-format.resource | |
Short | If parameter is a whole resource |
Definition | Conveys the content if the parameter is a whole resource. |
Cardinality | 0..0 |
Type | Resource |
Summary | True |
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. |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Parameters.parameter:time-format.part | |
Short | Named part of a multi-part parameter |
Definition | A named part of a multi-part parameter. |
Cardinality | 0..0 |
Type | see (parameter) |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:unit | |
Short | Specifies the unit mg/dL|mmol/L. |
Definition | A parameter passed to or received from the operation. |
Cardinality | 1..1 |
Type | BackboneElement |
Must Support | True |
Summary | True |
Constraints |
|
Parameters.parameter:unit.id | |
Short | Unique id for inter-element referencing |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0..1 |
Type | string |
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
Mappings |
|
Parameters.parameter:unit.extension | |
Short | Additional content defined by implementations |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Cardinality | 0..* |
Type | Extension |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:unit.modifierExtension | |
Short | Extensions that cannot be ignored even if unrecognized |
Definition | May 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). |
Cardinality | 0..* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:unit.name | |
Short | Name from the definition |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1..1 |
Type | string |
Summary | True |
Constraints |
|
Pattern | unit |
Parameters.parameter:unit.value[x] | |
Short | If parameter is a data type |
Definition | Conveys the content if the parameter is a data type. |
Cardinality | 1..1 |
Type | Coding |
Must Support | True |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:unit.resource | |
Short | If parameter is a whole resource |
Definition | Conveys the content if the parameter is a whole resource. |
Cardinality | 0..0 |
Type | Resource |
Summary | True |
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. |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Parameters.parameter:unit.part | |
Short | Named part of a multi-part parameter |
Definition | A named part of a multi-part parameter. |
Cardinality | 0..0 |
Type | see (parameter) |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:effectivePeriod | |
Short | Represents the start and end dates defining the period.The maximum Period for the generation of report is 14 days. |
Definition | A parameter passed to or received from the operation. |
Cardinality | 1..1 |
Type | BackboneElement |
Must Support | True |
Summary | True |
Constraints |
|
Parameters.parameter:effectivePeriod.id | |
Short | Unique id for inter-element referencing |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0..1 |
Type | string |
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
Mappings |
|
Parameters.parameter:effectivePeriod.extension | |
Short | Additional content defined by implementations |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Cardinality | 0..* |
Type | Extension |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:effectivePeriod.modifierExtension | |
Short | Extensions that cannot be ignored even if unrecognized |
Definition | May 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). |
Cardinality | 0..* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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. |
Constraints |
|
Mappings |
|
Parameters.parameter:effectivePeriod.name | |
Short | Name from the definition |
Definition | The name of the parameter (reference to the operation definition). |
Cardinality | 1..1 |
Type | string |
Summary | True |
Constraints |
|
Pattern | effectivePeriod |
Parameters.parameter:effectivePeriod.value[x] | |
Short | If parameter is a data type |
Definition | Conveys the content if the parameter is a data type. |
Cardinality | 1..1 |
Type | Period |
Must Support | True |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Parameters.parameter:effectivePeriod.resource | |
Short | If parameter is a whole resource |
Definition | Conveys the content if the parameter is a whole resource. |
Cardinality | 0..0 |
Type | Resource |
Summary | True |
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. |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Parameters.parameter:effectivePeriod.part | |
Short | Named part of a multi-part parameter |
Definition | A named part of a multi-part parameter. |
Cardinality | 0..0 |
Type | see (parameter) |
Summary | True |
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 |
Constraints |
|
Attribute description :
Attributes | Description | Terminology reference |
---|---|---|
reportType | Type of the report for which the report to be generated [ AgpPersonal , PatientMedicalData ] |
|
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 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" } } ] }