Parameters
Profile (Parameter) is for defining the parameters to be sent as a payload to generate an AGP report for a patient within an organization.
Canonical url - http://roche.com/fhir/iop/StructureDefinition/Parameters
The below overview shows the elements of the resource, data type and the cardinality of each. Further details like "Binding"/"Fixed values"/"Constraints" etc. can be found on clicking on each element.
Structure definition :
AgpReport-Parameters-profile (Parameters) | Parameters | There are no (further) constraints on this element Element idParameters Operation Request or Response 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. The parameters that may be used are defined by the OperationDefinition resource.
| ||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idParameters.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. 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. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idParameters.meta Metadata about the resource 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.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idParameters.implicitRules A set of rules under which this content was created 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. 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idParameters.language Language of the resource content DefinitionThe base language in which the resource is written. 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). IETF language tag for a human language
| |
parameter | Σ I | 0..* | BackboneElement | Element idParameters.parameter Operation Parameter DefinitionA parameter passed to or received from the operation. Unordered, Closed, by name(Value) Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers 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). 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. 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.
|
name | Σ | 1..1 | string | There are no (further) constraints on this element Element idParameters.parameter.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
|
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element idParameters.parameter.value[x] If parameter is a data type DefinitionConveys the content if the parameter is a data type.
| |
valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type | ||
valueBoolean | boolean | There are no (further) constraints on this element Data type | ||
valueCanonical | canonical() | There are no (further) constraints on this element Data type | ||
valueCode | code | There are no (further) constraints on this element Data type | ||
valueDate | date | There are no (further) constraints on this element Data type | ||
valueDateTime | dateTime | There are no (further) constraints on this element Data type | ||
valueDecimal | decimal | There are no (further) constraints on this element Data type | ||
valueId | id | There are no (further) constraints on this element Data type | ||
valueInstant | instant | There are no (further) constraints on this element Data type | ||
valueInteger | integer | There are no (further) constraints on this element Data type | ||
valueInteger64 | integer64 | There are no (further) constraints on this element Data type | ||
valueMarkdown | markdown | There are no (further) constraints on this element Data type | ||
valueOid | oid | There are no (further) constraints on this element Data type | ||
valuePositiveInt | positiveInt | There are no (further) constraints on this element Data type | ||
valueString | string | There are no (further) constraints on this element Data type | ||
valueTime | time | There are no (further) constraints on this element Data type | ||
valueUnsignedInt | unsignedInt | There are no (further) constraints on this element Data type | ||
valueUri | uri | There are no (further) constraints on this element Data type | ||
valueUrl | url | There are no (further) constraints on this element Data type | ||
valueUuid | uuid | There are no (further) constraints on this element Data type | ||
valueAddress | Address | There are no (further) constraints on this element Data type | ||
valueAge | Age | There are no (further) constraints on this element Data type | ||
valueAnnotation | Annotation | There are no (further) constraints on this element Data type | ||
valueAttachment | Attachment | There are no (further) constraints on this element Data type | ||
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
valueCoding | Coding | There are no (further) constraints on this element Data type | ||
valueContactPoint | ContactPoint | There are no (further) constraints on this element Data type | ||
valueCount | Count | There are no (further) constraints on this element Data type | ||
valueDistance | Distance | There are no (further) constraints on this element Data type | ||
valueDuration | Duration | There are no (further) constraints on this element Data type | ||
valueHumanName | HumanName | There are no (further) constraints on this element Data type | ||
valueIdentifier | Identifier | There are no (further) constraints on this element Data type | ||
valueMoney | Money | There are no (further) constraints on this element Data type | ||
valuePeriod | Period | There are no (further) constraints on this element Data type | ||
valueQuantity | Quantity | There are no (further) constraints on this element Data type | ||
valueRange | Range | There are no (further) constraints on this element Data type | ||
valueRatio | Ratio | There are no (further) constraints on this element Data type | ||
valueRatioRange | RatioRange | There are no (further) constraints on this element Data type | ||
valueSampledData | SampledData | There are no (further) constraints on this element Data type | ||
valueSignature | Signature | There are no (further) constraints on this element Data type | ||
valueTiming | Timing | There are no (further) constraints on this element Data type | ||
valueContactDetail | ContactDetail | There are no (further) constraints on this element Data type | ||
valueDataRequirement | DataRequirement | There are no (further) constraints on this element Data type | ||
valueExpression | Expression | There are no (further) constraints on this element Data type | ||
valueParameterDefinition | ParameterDefinition | There are no (further) constraints on this element Data type | ||
valueRelatedArtifact | RelatedArtifact | There are no (further) constraints on this element Data type | ||
valueTriggerDefinition | TriggerDefinition | There are no (further) constraints on this element Data type | ||
valueUsageContext | UsageContext | There are no (further) constraints on this element Data type | ||
valueAvailability | Availability | There are no (further) constraints on this element Data type | ||
valueExtendedContactDetail | ExtendedContactDetail | There are no (further) constraints on this element Data type | ||
valueDosage | Dosage | There are no (further) constraints on this element Data type | ||
valueMeta | Meta | There are no (further) constraints on this element Data type | ||
valueCodeableReference | CodeableReference() | There are no (further) constraints on this element Data type | ||
valueReference | Reference() | There are no (further) constraints on this element Data type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element idParameters.parameter.resource If parameter is a whole resource DefinitionConveys the content if the parameter is a whole resource. 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.
|
part | Σ I | 0..* | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. |
subject | S Σ I | 1..1 | BackboneElement | Element idParameters.parameter:subject Patient reference DefinitionReference to Patient resource with personal id.
|
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:subject.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:subject.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:subject.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers 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). 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. 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.
|
name | Σ | 1..1 | stringPattern | Element idParameters.parameter:subject.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
subject
|
value[x] | S Σ I | 1..1 | Element idParameters.parameter:subject.value[x] Patient reference DefinitionConveys the content if the parameter is a data type.
| |
valueReference | Reference() | Data type | ||
resource | Σ I | 0..0 | Resource | There are no (further) constraints on this element Element idParameters.parameter:subject.resource If parameter is a whole resource DefinitionConveys the content if the parameter is a whole resource. 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.
|
part | Σ I | 0..0 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:subject.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. |
locale | S Σ I | 1..1 | BackboneElement | Element idParameters.parameter:locale Specifies the language and locale encoding DefinitionText encoding
|
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:locale.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:locale.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:locale.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers 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). 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. 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.
|
name | Σ | 1..1 | stringPattern | Element idParameters.parameter:locale.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
locale
|
value[x] | S Σ I | 1..1 | Element idParameters.parameter:locale.value[x] Encoding DefinitionConveys the content if the parameter is a data type.
| |
valueString | string | Data type | ||
resource | Σ I | 0..0 | Resource | There are no (further) constraints on this element Element idParameters.parameter:locale.resource If parameter is a whole resource DefinitionConveys the content if the parameter is a whole resource. 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.
|
part | Σ I | 0..0 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:locale.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. |
orientation | S Σ I | 0..1 | BackboneElement | Element idParameters.parameter:orientation Defines the page orientation of the PDF, such as portrait or landscape (default portrait). DefinitionA parameter passed to or received from the operation.
|
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:orientation.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:orientation.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:orientation.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers 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). 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. 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.
|
name | Σ | 1..1 | stringPattern | Element idParameters.parameter:orientation.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
orientation
|
value[x] | S Σ I | 1..1 | Element idParameters.parameter:orientation.value[x] If parameter is a data type DefinitionConveys the content if the parameter is a data type.
| |
valueCode | code | Data type | ||
resource | Σ I | 0..0 | Resource | There are no (further) constraints on this element Element idParameters.parameter:orientation.resource If parameter is a whole resource DefinitionConveys the content if the parameter is a whole resource. 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.
|
part | Σ I | 0..0 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:orientation.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. |
timezone-offset | S Σ I | 0..1 | BackboneElement | Element idParameters.parameter:timezone-offset UTC offset for a time zone in ±hh:mm format (default will be server timezone). DefinitionA parameter passed to or received from the operation.
|
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:timezone-offset.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:timezone-offset.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:timezone-offset.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers 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). 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. 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.
|
name | Σ | 1..1 | stringPattern | Element idParameters.parameter:timezone-offset.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
timezone-offset
|
value[x] | S Σ I | 1..1 | There are no (further) constraints on this element Element idParameters.parameter:timezone-offset.value[x] If parameter is a data type DefinitionConveys the content if the parameter is a data type.
| |
valueString | string | Data type | ||
resource | Σ I | 0..0 | Resource | There are no (further) constraints on this element Element idParameters.parameter:timezone-offset.resource If parameter is a whole resource DefinitionConveys the content if the parameter is a whole resource. 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.
|
part | Σ I | 0..0 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:timezone-offset.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. |
time-format | S Σ I | 0..1 | BackboneElement | Element idParameters.parameter:time-format Specifies the time format, such as 12H for 12-hour or 24H for 24-hour format (default 24H). DefinitionA parameter passed to or received from the operation.
|
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:time-format.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:time-format.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:time-format.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers 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). 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. 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.
|
name | Σ | 1..1 | stringPattern | Element idParameters.parameter:time-format.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
time-format
|
value[x] | S Σ I | 1..1 | Element idParameters.parameter:time-format.value[x] If parameter is a data type DefinitionConveys the content if the parameter is a data type.
| |
valueCode | code | Data type | ||
resource | Σ I | 0..0 | Resource | There are no (further) constraints on this element Element idParameters.parameter:time-format.resource If parameter is a whole resource DefinitionConveys the content if the parameter is a whole resource. 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.
|
part | Σ I | 0..0 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:time-format.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. |
unit | S Σ I | 1..1 | BackboneElement | Element idParameters.parameter:unit Specifies the unit mg/dL|mmol/L. DefinitionA parameter passed to or received from the operation.
|
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:unit.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:unit.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:unit.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers 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). 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. 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.
|
name | Σ | 1..1 | stringPattern | Element idParameters.parameter:unit.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
unit
|
value[x] | S Σ I | 1..1 | Element idParameters.parameter:unit.value[x] If parameter is a data type DefinitionConveys the content if the parameter is a data type.
| |
valueCoding | Coding | Data type | ||
resource | Σ I | 0..0 | Resource | There are no (further) constraints on this element Element idParameters.parameter:unit.resource If parameter is a whole resource DefinitionConveys the content if the parameter is a whole resource. 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.
|
part | Σ I | 0..0 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:unit.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. |
effectivePeriod | S Σ I | 1..1 | BackboneElement | Element idParameters.parameter:effectivePeriod Represents the start and end dates defining the period.The maximum Period for the generation of report is 14 days. DefinitionA parameter passed to or received from the operation.
|
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:effectivePeriod.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:effectivePeriod.extension Additional content defined by implementations Alternate namesextensions, user content 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:effectivePeriod.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers 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). 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. 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.
|
name | Σ | 1..1 | stringPattern | Element idParameters.parameter:effectivePeriod.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). Note that FHIR strings SHALL NOT exceed 1,048,576 (1024*1024) characters in size
effectivePeriod
|
value[x] | S Σ I | 1..1 | There are no (further) constraints on this element Element idParameters.parameter:effectivePeriod.value[x] If parameter is a data type DefinitionConveys the content if the parameter is a data type.
| |
valuePeriod | Period | Data type | ||
resource | Σ I | 0..0 | Resource | There are no (further) constraints on this element Element idParameters.parameter:effectivePeriod.resource If parameter is a whole resource DefinitionConveys the content if the parameter is a whole resource. 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.
|
part | Σ I | 0..0 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:effectivePeriod.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. |
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. |