Profiles & Transactions > Parameters Profile
Structure Definition: Parameters Profile
Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/ca-on-cms-profile-Parameters-Consumer
Simplifier project page: CMSParametersConsumer
Derived from: Parameters (R4)
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work
Differential View
CMSParametersConsumer (Parameters) | Parameters | There are no (further) constraints on this element Element idParameters Operation Request or Response DefinitionThis resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it. 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. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | S Σ | 1..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. |
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.meta.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 | 0..* | Extension | There are no (further) constraints on this element Element idParameters.meta.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 manageable, 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 Mappings
| |
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idParameters.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idParameters.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idParameters.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
profile | S Σ | 1..* | canonical(StructureDefinition) | Element idParameters.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idParameters.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. |
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idParameters.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
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 it's 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). A human language. | |
parameter | Σ I | 0..* | BackboneElement | Element idParameters.parameter Operation Parameter DefinitionA parameter passed to or received from the operation. Unordered, Open, 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 | 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 manageable, 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.
| |
modifierExtension | Σ ?! | 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 manageable, 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). |
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element idParameters.parameter.value[x] If parameter is a data type DefinitionIf 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 | ||
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 | ||
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 | ||
valueContributor | Contributor | 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 | ||
valueDosage | Dosage | 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 DefinitionIf 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 it's general resource resolution methods. |
part | Σ | 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. Only one level of nested parameters is allowed. |
appLanguage | S Σ I | 0..1 | BackboneElement | Element idParameters.parameter:appLanguage Operation Parameter Definition
|
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.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 | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.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 manageable, 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.
| |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.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 manageable, 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 | S Σ | 1..1 | stringFixed Value | Element idParameters.parameter:appLanguage.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). appLanguage |
value[x] | S Σ I | 0..1 | Binding | Element idParameters.parameter:appLanguage.value[x] The value of appLanguage is of type 'coding' DefinitionIf the parameter is a data type. appLanguage indicates the languages supported by an EMR app. |
valueCoding | Coding | Data type | ||
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].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 | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].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 manageable, 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 Mappings
| |
system | S Σ | 0..1 | uriFixed Value | Element idParameters.parameter:appLanguage.value[x].system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. urn:ietf:bcp:47
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.resource If parameter is a whole resource DefinitionIf 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 it's general resource resolution methods. |
part | Σ | 0..1 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
contextSessionId | S Σ I | 0..1 | BackboneElement | Element idParameters.parameter:contextSessionId Operation Parameter DefinitionA parameter passed to or received from the operation. contextSessionId is to support backward compatibility of the legacy CMS If not populated by EMRs, the backend should auto populate contextSessionId from OAuth token.
|
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.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 | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.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 manageable, 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.
| |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.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 manageable, 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 | S Σ | 1..1 | stringFixed Value | Element idParameters.parameter:contextSessionId.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). contextSessionId |
value[x] | S Σ I | 0..1 | Element idParameters.parameter:contextSessionId.value[x] The value of contextSessionId is of type 'id' DefinitionIf the parameter is a data type. contextSessionId is auto populated from the OAuth token | |
valueId | id | Data type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.resource If parameter is a whole resource DefinitionIf 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 it's general resource resolution methods. |
part | Σ | 0..1 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
Hybrid View
CMSParametersConsumer (Parameters) | Parameters | There are no (further) constraints on this element Element idParameters Operation Request or Response DefinitionThis resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it. 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. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | S Σ | 1..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. |
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.meta.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 | 0..* | Extension | There are no (further) constraints on this element Element idParameters.meta.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 manageable, 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 Mappings
| |
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idParameters.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idParameters.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idParameters.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
profile | S Σ | 1..* | canonical(StructureDefinition) | Element idParameters.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idParameters.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. |
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idParameters.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
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 it's 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). A human language. | |
parameter | Σ I | 0..* | BackboneElement | Element idParameters.parameter Operation Parameter DefinitionA parameter passed to or received from the operation. Unordered, Open, 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 | 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 manageable, 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.
| |
modifierExtension | Σ ?! | 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 manageable, 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). |
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element idParameters.parameter.value[x] If parameter is a data type DefinitionIf 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 | ||
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 | ||
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 | ||
valueContributor | Contributor | 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 | ||
valueDosage | Dosage | 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 DefinitionIf 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 it's general resource resolution methods. |
part | Σ | 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. Only one level of nested parameters is allowed. |
appLanguage | S Σ I | 0..1 | BackboneElement | Element idParameters.parameter:appLanguage Operation Parameter Definition
|
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.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 | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.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 manageable, 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.
| |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.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 manageable, 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 | S Σ | 1..1 | stringFixed Value | Element idParameters.parameter:appLanguage.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). appLanguage |
value[x] | S Σ I | 0..1 | Binding | Element idParameters.parameter:appLanguage.value[x] The value of appLanguage is of type 'coding' DefinitionIf the parameter is a data type. appLanguage indicates the languages supported by an EMR app. |
valueCoding | Coding | Data type | ||
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].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 | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].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 manageable, 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 Mappings
| |
system | S Σ | 0..1 | uriFixed Value | Element idParameters.parameter:appLanguage.value[x].system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. urn:ietf:bcp:47
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.resource If parameter is a whole resource DefinitionIf 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 it's general resource resolution methods. |
part | Σ | 0..1 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
contextSessionId | S Σ I | 0..1 | BackboneElement | Element idParameters.parameter:contextSessionId Operation Parameter DefinitionA parameter passed to or received from the operation. contextSessionId is to support backward compatibility of the legacy CMS If not populated by EMRs, the backend should auto populate contextSessionId from OAuth token.
|
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.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 | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.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 manageable, 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.
| |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.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 manageable, 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 | S Σ | 1..1 | stringFixed Value | Element idParameters.parameter:contextSessionId.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). contextSessionId |
value[x] | S Σ I | 0..1 | Element idParameters.parameter:contextSessionId.value[x] The value of contextSessionId is of type 'id' DefinitionIf the parameter is a data type. contextSessionId is auto populated from the OAuth token | |
valueId | id | Data type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.resource If parameter is a whole resource DefinitionIf 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 it's general resource resolution methods. |
part | Σ | 0..1 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
Snapshot View
CMSParametersConsumer (Parameters) | Parameters | There are no (further) constraints on this element Element idParameters Operation Request or Response DefinitionThis resource is a non-persisted resource used to pass information into and back from an operation. It has no other use, and there is no RESTful endpoint associated with it. 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. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | S Σ | 1..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. |
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.meta.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 | 0..* | Extension | There are no (further) constraints on this element Element idParameters.meta.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 manageable, 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 Mappings
| |
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idParameters.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idParameters.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idParameters.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
profile | S Σ | 1..* | canonical(StructureDefinition) | Element idParameters.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idParameters.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. |
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idParameters.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
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 it's 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). A human language. | |
parameter | Σ I | 0..* | BackboneElement | Element idParameters.parameter Operation Parameter DefinitionA parameter passed to or received from the operation. Unordered, Open, 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 | 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 manageable, 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.
| |
modifierExtension | Σ ?! | 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 manageable, 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). |
value[x] | Σ I | 0..1 | There are no (further) constraints on this element Element idParameters.parameter.value[x] If parameter is a data type DefinitionIf 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 | ||
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 | ||
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 | ||
valueContributor | Contributor | 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 | ||
valueDosage | Dosage | 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 DefinitionIf 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 it's general resource resolution methods. |
part | Σ | 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. Only one level of nested parameters is allowed. |
appLanguage | S Σ I | 0..1 | BackboneElement | Element idParameters.parameter:appLanguage Operation Parameter Definition
|
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.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 | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.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 manageable, 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.
| |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.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 manageable, 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 | S Σ | 1..1 | stringFixed Value | Element idParameters.parameter:appLanguage.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). appLanguage |
value[x] | S Σ I | 0..1 | Binding | Element idParameters.parameter:appLanguage.value[x] The value of appLanguage is of type 'coding' DefinitionIf the parameter is a data type. appLanguage indicates the languages supported by an EMR app. |
valueCoding | Coding | Data type | ||
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].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 | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].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 manageable, 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 Mappings
| |
system | S Σ | 0..1 | uriFixed Value | Element idParameters.parameter:appLanguage.value[x].system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. urn:ietf:bcp:47
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system.
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.value[x].userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.resource If parameter is a whole resource DefinitionIf 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 it's general resource resolution methods. |
part | Σ | 0..1 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:appLanguage.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
contextSessionId | S Σ I | 0..1 | BackboneElement | Element idParameters.parameter:contextSessionId Operation Parameter DefinitionA parameter passed to or received from the operation. contextSessionId is to support backward compatibility of the legacy CMS If not populated by EMRs, the backend should auto populate contextSessionId from OAuth token.
|
id | 0..1 | string | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.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 | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.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 manageable, 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.
| |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.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 manageable, 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 | S Σ | 1..1 | stringFixed Value | Element idParameters.parameter:contextSessionId.name Name from the definition DefinitionThe name of the parameter (reference to the operation definition). contextSessionId |
value[x] | S Σ I | 0..1 | Element idParameters.parameter:contextSessionId.value[x] The value of contextSessionId is of type 'id' DefinitionIf the parameter is a data type. contextSessionId is auto populated from the OAuth token | |
valueId | id | Data type | ||
resource | Σ I | 0..1 | Resource | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.resource If parameter is a whole resource DefinitionIf 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 it's general resource resolution methods. |
part | Σ | 0..1 | see (parameter) | There are no (further) constraints on this element Element idParameters.parameter:contextSessionId.part Named part of a multi-part parameter DefinitionA named part of a multi-part parameter. Only one level of nested parameters is allowed. |
Table View
Parameters | .. | |
Parameters.meta | 1.. | |
Parameters.meta.profile | 1.. | |
Parameters.parameter | .. | |
Parameters.parameter | ..1 | |
Parameters.parameter.name | .. | |
Parameters.parameter.value[x] | Coding | .. |
Parameters.parameter.value[x].system | .. | |
Parameters.parameter.value[x].code | .. | |
Parameters.parameter.value[x].display | .. | |
Parameters.parameter.part | ..1 | |
Parameters.parameter | ..1 | |
Parameters.parameter.name | .. | |
Parameters.parameter.value[x] | id | .. |
Parameters.parameter.part | ..1 |
JSON View
{ "resourceType": "StructureDefinition", "text": { "status": "empty", --- We have skipped the narrative for better readability of the resource --- }, "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-cms-profile-Parameters-Consumer", "version": "0.1.0", "name": "CMSParametersConsumer", "status": "draft", "description": "Please see <a href=\"https://simplifier.net/guide/OntarioContextManagement/ConformanceRules\" target=\"_blank\">Conformance Rules </a> for the expected behavior of MustSupport.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Parameters", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Parameters", "derivation": "constraint", "differential": { "element": [ { "id": "Parameters.meta", "path": "Parameters.meta", "min": 1, "mustSupport": true }, { "id": "Parameters.meta.profile", "path": "Parameters.meta.profile", "comment": "#### **_` FOR CMS USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-cms-profile-Parameters-Consumer|1.0.0 `_**\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.", "min": 1, "mustSupport": true }, { "id": "Parameters.parameter", "path": "Parameters.parameter", "slicing": { "discriminator": [ { "type": "value", "path": "name" } ], "rules": "open" } }, { "id": "Parameters.parameter:appLanguage", "path": "Parameters.parameter", "sliceName": "appLanguage", "definition": "#### **_` appLanguage specifies the launguage supported by the lauching app. CMS supports English & French. `_**\n\n<a href=\"https://simplifier.net/OntarioContextManagement/human-language\" target=\"_blank\">Canonical URL: http://ehealthontario.ca/fhir/ValueSet/human-language </a>", "max": "1", "mustSupport": true }, { "id": "Parameters.parameter:appLanguage.name", "path": "Parameters.parameter.name", "fixedString": "appLanguage", "mustSupport": true }, { "id": "Parameters.parameter:appLanguage.value[x]", "path": "Parameters.parameter.value[x]", "short": "The value of appLanguage is of type 'coding'", "comment": "appLanguage indicates the languages supported by an EMR app.", "type": [ { "code": "Coding" } ], "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://ehealthontario.ca/fhir/ValueSet/human-language" } }, { "id": "Parameters.parameter:appLanguage.value[x].system", "path": "Parameters.parameter.value[x].system", "fixedUri": "urn:ietf:bcp:47", "mustSupport": true }, { "id": "Parameters.parameter:appLanguage.value[x].code", "path": "Parameters.parameter.value[x].code", "mustSupport": true }, { "id": "Parameters.parameter:appLanguage.value[x].display", "path": "Parameters.parameter.value[x].display", "mustSupport": true }, { "id": "Parameters.parameter:appLanguage.part", "path": "Parameters.parameter.part", "max": "1" }, { "id": "Parameters.parameter:contextSessionId", "path": "Parameters.parameter", "sliceName": "contextSessionId", "comment": "contextSessionId is to support backward compatibility of the legacy CMS \nIf not populated by EMRs, the backend should auto populate contextSessionId from OAuth token.", "max": "1", "mustSupport": true }, { "id": "Parameters.parameter:contextSessionId.name", "path": "Parameters.parameter.name", "fixedString": "contextSessionId", "mustSupport": true }, { "id": "Parameters.parameter:contextSessionId.value[x]", "path": "Parameters.parameter.value[x]", "short": "The value of contextSessionId is of type 'id'", "comment": "contextSessionId is auto populated from the OAuth token", "type": [ { "code": "id" } ], "mustSupport": true }, { "id": "Parameters.parameter:contextSessionId.part", "path": "Parameters.parameter.part", "max": "1" } ] } }