Vital Records FHIR Messaging (VRFM) IG
1.0.0 - release

Vital Records FHIR Messaging (VRFM) IG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: StatusParameters - Detailed Descriptions

Draft as of 2023-12-28

Definitions for the VRM-StatusParameters resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Parameters
2. Parameters.parameter
Control1..?
SlicingThis element introduces a set of slices on Parameters.parameter. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ name
4. Parameters.parameter:jurisdiction_id
Slice Namejurisdiction_id
Definition

2 character identifier for one of 57 reporting jurisdictions

Shortjurisdiction identifier
Control0..1
6. Parameters.parameter:jurisdiction_id.extension
Control0..0
8. Parameters.parameter:jurisdiction_id.name
Pattern Valuejurisdiction_id
10. Parameters.parameter:jurisdiction_id.value[x]
Control1..?
BindingThe codes SHALL be taken from Jurisdictions Value Set
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. Parameters.parameter:jurisdiction_id.resource
Control0..0
14. Parameters.parameter:jurisdiction_id.part
Control0..0
16. Parameters.parameter:cert_no
Slice Namecert_no
Definition

death certificate number

ShortFILENO death certificate number
Control0..1
18. Parameters.parameter:cert_no.extension
Control0..0
20. Parameters.parameter:cert_no.name
Pattern Valuecert_no
22. Parameters.parameter:cert_no.value[x]
Control1..?
TypeunsignedInt
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. Parameters.parameter:cert_no.resource
Control0..0
26. Parameters.parameter:cert_no.part
Control0..0
28. Parameters.parameter:death_year
Slice Namedeath_year
Definition

four digit death year

ShortDOD_YR death year
Control0..1
30. Parameters.parameter:death_year.extension
Control0..0
32. Parameters.parameter:death_year.name
Pattern Valuedeath_year
34. Parameters.parameter:death_year.value[x]
Control1..?
TypeunsignedInt
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. Parameters.parameter:death_year.resource
Control0..0
38. Parameters.parameter:death_year.part
Control0..0
40. Parameters.parameter:state_auxiliary_id
Slice Namestate_auxiliary_id
Definition

state auxiliary identifier

ShortAUXNO state auxiliary identifier
Control0..1
42. Parameters.parameter:state_auxiliary_id.extension
Control0..0
44. Parameters.parameter:state_auxiliary_id.name
Pattern Valuestate_auxiliary_id
46. Parameters.parameter:state_auxiliary_id.value[x]
Control1..?
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
48. Parameters.parameter:state_auxiliary_id.resource
Control0..0
50. Parameters.parameter:state_auxiliary_id.part
Control0..0
52. Parameters.parameter:status
Slice Namestatus
Definition

status type

Shortstatus type
Control1..1
54. Parameters.parameter:status.extension
Control0..0
56. Parameters.parameter:status.name
Pattern Valuestatus
58. Parameters.parameter:status.value[x]
Control1..?
BindingThe codes SHALL be taken from Status Codes Values
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
60. Parameters.parameter:status.resource
Control0..0
62. Parameters.parameter:status.part
Control0..0

Guidance on how to interpret the contents of this table can be found here

0. Parameters
Definition

This 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.

ShortOperation Request or Response
Comments

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

Control0..*
2. Parameters.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Parameters.parameter
Definition

A parameter passed to or received from the operation.

ShortOperation Parameter
Control10..*
This element is affected by the following invariants: ele-1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
SlicingThis element introduces a set of slices on Parameters.parameter. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ name
6. Parameters.parameter.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Parameters.parameter.name
Definition

The name of the parameter (reference to the operation definition).

ShortName from the definition
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Parameters.parameter.value[x]
Definition

If the parameter is a data type.

ShortIf parameter is a data type
Control0..1
This element is affected by the following invariants: ele-1, inv-1
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Parameters.parameter:jurisdiction_id
Slice Namejurisdiction_id
Definition

2 character identifier for one of 57 reporting jurisdictions


A parameter passed to or received from the operation.

Shortjurisdiction identifierOperation Parameter
Control0..1*
This element is affected by the following invariants: ele-1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
14. Parameters.parameter:jurisdiction_id.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
This element is affected by the following invariants: ele-1
TypeExtension
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Parameters.parameter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. Parameters.parameter:jurisdiction_id.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Parameters.parameter:jurisdiction_id.name
Definition

The name of the parameter (reference to the operation definition).

ShortName from the definition
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Pattern Valuejurisdiction_id
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Parameters.parameter:jurisdiction_id.value[x]
Definition

If the parameter is a data type.

ShortIf parameter is a data type
Control10..1
This element is affected by the following invariants: ele-1, inv-1
BindingThe codes SHALL be taken from For codes, see Jurisdictions Value Set
Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Parameters.parameter:jurisdiction_id.resource
Definition

If the parameter is a whole resource.

ShortIf parameter is a whole resource
Comments

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

Control0..01
This element is affected by the following invariants: inv-1
TypeResource
Summarytrue
24. Parameters.parameter:jurisdiction_id.part
Definition

A named part of a multi-part parameter.

ShortNamed part of a multi-part parameter
Comments

Only one level of nested parameters is allowed.

Control0..0*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Summarytrue
26. Parameters.parameter:cert_no
Slice Namecert_no
Definition

death certificate number


A parameter passed to or received from the operation.

ShortFILENO death certificate numberOperation Parameter
Control0..1*
This element is affected by the following invariants: ele-1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
28. Parameters.parameter:cert_no.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
This element is affected by the following invariants: ele-1
TypeExtension
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Parameters.parameter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
30. Parameters.parameter:cert_no.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. Parameters.parameter:cert_no.name
Definition

The name of the parameter (reference to the operation definition).

ShortName from the definition
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Pattern Valuecert_no
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Parameters.parameter:cert_no.value[x]
Definition

If the parameter is a data type.

ShortIf parameter is a data type
Control10..1
This element is affected by the following invariants: ele-1, inv-1
TypeunsignedInt, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Parameters.parameter:cert_no.resource
Definition

If the parameter is a whole resource.

ShortIf parameter is a whole resource
Comments

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

Control0..01
This element is affected by the following invariants: inv-1
TypeResource
Summarytrue
38. Parameters.parameter:cert_no.part
Definition

A named part of a multi-part parameter.

ShortNamed part of a multi-part parameter
Comments

Only one level of nested parameters is allowed.

Control0..0*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Summarytrue
40. Parameters.parameter:death_year
Slice Namedeath_year
Definition

four digit death year


A parameter passed to or received from the operation.

ShortDOD_YR death yearOperation Parameter
Control0..1*
This element is affected by the following invariants: ele-1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
42. Parameters.parameter:death_year.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
This element is affected by the following invariants: ele-1
TypeExtension
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Parameters.parameter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
44. Parameters.parameter:death_year.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
46. Parameters.parameter:death_year.name
Definition

The name of the parameter (reference to the operation definition).

ShortName from the definition
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Pattern Valuedeath_year
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Parameters.parameter:death_year.value[x]
Definition

If the parameter is a data type.

ShortIf parameter is a data type
Control10..1
This element is affected by the following invariants: ele-1, inv-1
TypeunsignedInt, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Parameters.parameter:death_year.resource
Definition

If the parameter is a whole resource.

ShortIf parameter is a whole resource
Comments

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

Control0..01
This element is affected by the following invariants: inv-1
TypeResource
Summarytrue
52. Parameters.parameter:death_year.part
Definition

A named part of a multi-part parameter.

ShortNamed part of a multi-part parameter
Comments

Only one level of nested parameters is allowed.

Control0..0*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Summarytrue
54. Parameters.parameter:state_auxiliary_id
Slice Namestate_auxiliary_id
Definition

state auxiliary identifier


A parameter passed to or received from the operation.

ShortAUXNO state auxiliary identifierOperation Parameter
Control0..1*
This element is affected by the following invariants: ele-1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
56. Parameters.parameter:state_auxiliary_id.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
This element is affected by the following invariants: ele-1
TypeExtension
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Parameters.parameter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
58. Parameters.parameter:state_auxiliary_id.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
60. Parameters.parameter:state_auxiliary_id.name
Definition

The name of the parameter (reference to the operation definition).

ShortName from the definition
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Pattern Valuestate_auxiliary_id
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Parameters.parameter:state_auxiliary_id.value[x]
Definition

If the parameter is a data type.

ShortIf parameter is a data type
Control10..1
This element is affected by the following invariants: ele-1, inv-1
Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Parameters.parameter:state_auxiliary_id.resource
Definition

If the parameter is a whole resource.

ShortIf parameter is a whole resource
Comments

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

Control0..01
This element is affected by the following invariants: inv-1
TypeResource
Summarytrue
66. Parameters.parameter:state_auxiliary_id.part
Definition

A named part of a multi-part parameter.

ShortNamed part of a multi-part parameter
Comments

Only one level of nested parameters is allowed.

Control0..0*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Summarytrue
68. Parameters.parameter:status
Slice Namestatus
Definition

status type


A parameter passed to or received from the operation.

Shortstatus typeOperation Parameter
Control10..1*
This element is affected by the following invariants: ele-1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
70. Parameters.parameter:status.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..0*
This element is affected by the following invariants: ele-1
TypeExtension
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Parameters.parameter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
72. Parameters.parameter:status.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
74. Parameters.parameter:status.name
Definition

The name of the parameter (reference to the operation definition).

ShortName from the definition
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Pattern Valuestatus
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Parameters.parameter:status.value[x]
Definition

If the parameter is a data type.

ShortIf parameter is a data type
Control10..1
This element is affected by the following invariants: ele-1, inv-1
BindingThe codes SHALL be taken from For codes, see Status Codes Values
Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. Parameters.parameter:status.resource
Definition

If the parameter is a whole resource.

ShortIf parameter is a whole resource
Comments

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

Control0..01
This element is affected by the following invariants: inv-1
TypeResource
Summarytrue
80. Parameters.parameter:status.part
Definition

A named part of a multi-part parameter.

ShortNamed part of a multi-part parameter
Comments

Only one level of nested parameters is allowed.

Control0..0*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Summarytrue

Guidance on how to interpret the contents of this table can be found here

0. Parameters
Definition

This 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.

ShortOperation Request or Response
Comments

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

Control0..*
2. Parameters.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Summarytrue
4. Parameters.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
This element is affected by the following invariants: ele-1
TypeMeta
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Parameters.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Parameters.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

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

Control0..1
This element is affected by the following invariants: ele-1
BindingThe codes SHOULD be taken from CommonLanguages

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Parameters.parameter
Definition

A parameter passed to or received from the operation.

ShortOperation Parameter
Control1..*
This element is affected by the following invariants: ele-1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
SlicingThis element introduces a set of slices on Parameters.parameter. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ name
12. Parameters.parameter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
14. Parameters.parameter.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Standards StatusNormative (from Normative)
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Parameters.parameter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. Parameters.parameter.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Parameters.parameter.name
Definition

The name of the parameter (reference to the operation definition).

ShortName from the definition
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Parameters.parameter.value[x]
Definition

If the parameter is a data type.

ShortIf parameter is a data type
Control0..1
This element is affected by the following invariants: ele-1, inv-1
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Parameters.parameter.resource
Definition

If the parameter is a whole resource.

ShortIf parameter is a whole resource
Comments

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

Control0..1
This element is affected by the following invariants: inv-1
TypeResource
Summarytrue
24. Parameters.parameter.part
Definition

A named part of a multi-part parameter.

ShortNamed part of a multi-part parameter
Comments

Only one level of nested parameters is allowed.

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Summarytrue
26. Parameters.parameter:jurisdiction_id
Slice Namejurisdiction_id
Definition

2 character identifier for one of 57 reporting jurisdictions

Shortjurisdiction identifier
Control0..1
This element is affected by the following invariants: ele-1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
28. Parameters.parameter:jurisdiction_id.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
30. Parameters.parameter:jurisdiction_id.extension
Definition

An Extension

ShortExtension
Control0..0
This element is affected by the following invariants: ele-1
TypeExtension
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Parameters.parameter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
32. Parameters.parameter:jurisdiction_id.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. Parameters.parameter:jurisdiction_id.name
Definition

The name of the parameter (reference to the operation definition).

ShortName from the definition
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Pattern Valuejurisdiction_id
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Parameters.parameter:jurisdiction_id.value[x]
Definition

If the parameter is a data type.

ShortIf parameter is a data type
Control1..1
This element is affected by the following invariants: ele-1, inv-1
BindingThe codes SHALL be taken from Jurisdictions Value Set
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Parameters.parameter:jurisdiction_id.resource
Definition

If the parameter is a whole resource.

ShortIf parameter is a whole resource
Comments

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

Control0..0
This element is affected by the following invariants: inv-1
TypeResource
Summarytrue
40. Parameters.parameter:jurisdiction_id.part
Definition

A named part of a multi-part parameter.

ShortNamed part of a multi-part parameter
Comments

Only one level of nested parameters is allowed.

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Summarytrue
42. Parameters.parameter:cert_no
Slice Namecert_no
Definition

death certificate number

ShortFILENO death certificate number
Control0..1
This element is affected by the following invariants: ele-1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
44. Parameters.parameter:cert_no.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
46. Parameters.parameter:cert_no.extension
Definition

An Extension

ShortExtension
Control0..0
This element is affected by the following invariants: ele-1
TypeExtension
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Parameters.parameter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
48. Parameters.parameter:cert_no.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
50. Parameters.parameter:cert_no.name
Definition

The name of the parameter (reference to the operation definition).

ShortName from the definition
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Pattern Valuecert_no
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Parameters.parameter:cert_no.value[x]
Definition

If the parameter is a data type.

ShortIf parameter is a data type
Control1..1
This element is affected by the following invariants: ele-1, inv-1
TypeunsignedInt
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Parameters.parameter:cert_no.resource
Definition

If the parameter is a whole resource.

ShortIf parameter is a whole resource
Comments

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

Control0..0
This element is affected by the following invariants: inv-1
TypeResource
Summarytrue
56. Parameters.parameter:cert_no.part
Definition

A named part of a multi-part parameter.

ShortNamed part of a multi-part parameter
Comments

Only one level of nested parameters is allowed.

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Summarytrue
58. Parameters.parameter:death_year
Slice Namedeath_year
Definition

four digit death year

ShortDOD_YR death year
Control0..1
This element is affected by the following invariants: ele-1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
60. Parameters.parameter:death_year.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
62. Parameters.parameter:death_year.extension
Definition

An Extension

ShortExtension
Control0..0
This element is affected by the following invariants: ele-1
TypeExtension
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Parameters.parameter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
64. Parameters.parameter:death_year.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
66. Parameters.parameter:death_year.name
Definition

The name of the parameter (reference to the operation definition).

ShortName from the definition
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Pattern Valuedeath_year
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Parameters.parameter:death_year.value[x]
Definition

If the parameter is a data type.

ShortIf parameter is a data type
Control1..1
This element is affected by the following invariants: ele-1, inv-1
TypeunsignedInt
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Parameters.parameter:death_year.resource
Definition

If the parameter is a whole resource.

ShortIf parameter is a whole resource
Comments

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

Control0..0
This element is affected by the following invariants: inv-1
TypeResource
Summarytrue
72. Parameters.parameter:death_year.part
Definition

A named part of a multi-part parameter.

ShortNamed part of a multi-part parameter
Comments

Only one level of nested parameters is allowed.

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Summarytrue
74. Parameters.parameter:state_auxiliary_id
Slice Namestate_auxiliary_id
Definition

state auxiliary identifier

ShortAUXNO state auxiliary identifier
Control0..1
This element is affected by the following invariants: ele-1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
76. Parameters.parameter:state_auxiliary_id.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
78. Parameters.parameter:state_auxiliary_id.extension
Definition

An Extension

ShortExtension
Control0..0
This element is affected by the following invariants: ele-1
TypeExtension
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Parameters.parameter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
80. Parameters.parameter:state_auxiliary_id.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
82. Parameters.parameter:state_auxiliary_id.name
Definition

The name of the parameter (reference to the operation definition).

ShortName from the definition
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Pattern Valuestate_auxiliary_id
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. Parameters.parameter:state_auxiliary_id.value[x]
Definition

If the parameter is a data type.

ShortIf parameter is a data type
Control1..1
This element is affected by the following invariants: ele-1, inv-1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Parameters.parameter:state_auxiliary_id.resource
Definition

If the parameter is a whole resource.

ShortIf parameter is a whole resource
Comments

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

Control0..0
This element is affected by the following invariants: inv-1
TypeResource
Summarytrue
88. Parameters.parameter:state_auxiliary_id.part
Definition

A named part of a multi-part parameter.

ShortNamed part of a multi-part parameter
Comments

Only one level of nested parameters is allowed.

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Summarytrue
90. Parameters.parameter:status
Slice Namestatus
Definition

status type

Shortstatus type
Control1..1
This element is affected by the following invariants: ele-1
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
inv-1: A parameter must have one and only one of (value, resource, part) ((part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
92. Parameters.parameter:status.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
XML FormatIn the XML format, this property is represented as an attribute.
94. Parameters.parameter:status.extension
Definition

An Extension

ShortExtension
Control0..0
This element is affected by the following invariants: ele-1
TypeExtension
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Parameters.parameter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
96. Parameters.parameter:status.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

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

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
98. Parameters.parameter:status.name
Definition

The name of the parameter (reference to the operation definition).

ShortName from the definition
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Control1..1
This element is affected by the following invariants: ele-1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Pattern Valuestatus
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. Parameters.parameter:status.value[x]
Definition

If the parameter is a data type.

ShortIf parameter is a data type
Control1..1
This element is affected by the following invariants: ele-1, inv-1
BindingThe codes SHALL be taken from Status Codes Values
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. Parameters.parameter:status.resource
Definition

If the parameter is a whole resource.

ShortIf parameter is a whole resource
Comments

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

Control0..0
This element is affected by the following invariants: inv-1
TypeResource
Summarytrue
104. Parameters.parameter:status.part
Definition

A named part of a multi-part parameter.

ShortNamed part of a multi-part parameter
Comments

Only one level of nested parameters is allowed.

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Summarytrue