Operations
| Hinweis | Diese Box bitte entfernen! |
|---|---|
 |
Diese Seite ist ein Template, das bei Verwendung für ein konkretes Projekt angepasst werden muss! Dieses Banner kann verwendet werden, um zu kennzeichnen, welche Seiten noch nicht bearbeitet wurden, sich gerade in Arbeit befinden oder um auf offene Punkte hinzuweisen. |
Add profiles, tags, and security labels to a resource
Metadaten
You need a license to run FQL queries
Inhalt
Invocations
URL: [base]/Resource/[id]/$meta-add
Parameters (In)
| Name | Cardinality | Type | Documentation |
| meta | 1..1 | Meta | Profiles, tags, and security labels to add to the existing resource. Note that profiles, tags, and security labels are sets, and duplicates are not created. The identity of a tag or security label is the system+code. When matching existing tags during adding, version and display are ignored. For profiles, matching is based on the full URL |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
| return | 1..1 | Meta | Resulting meta for the resource |
You need a license to run FQL queries
<OperationDefinition xmlns="http://hl7.org/fhir"> <id value="Resource-meta-add" /> <meta> <lastUpdated value="2019-11-01T09:29:23.356+11:00" /> </meta> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="3" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="trial-use" /> </extension> <url value="http://hl7.org/fhir/OperationDefinition/Resource-meta-add" /> <version value="4.0.1" /> <name value="Add profiles, tags, and security labels to a resource" /> <status value="draft" /> <kind value="operation" /> <date value="2019-11-01T09:29:23+11:00" /> <publisher value="HL7 (FHIR Project)" /> <contact> <telecom> <system value="url" /> <value value="http://hl7.org/fhir" /> </telecom> <telecom> <system value="email" /> <value value="fhir@lists.hl7.org" /> </telecom> </contact> <description value="This operation takes a meta, and adds the profiles, tags, and security labels found in it to the nominated resource" /> <code value="meta-add" /> <resource value="Resource" /> <system value="false" /> <type value="false" /> <instance value="true" /> <parameter> <name value="meta" /> <use value="in" /> <min value="1" /> <max value="1" /> <documentation value="Profiles, tags, and security labels to add to the existing resource. Note that profiles, tags, and security labels are sets, and duplicates are not created. The identity of a tag or security label is the system+code. When matching existing tags during adding, version and display are ignored. For profiles, matching is based on the full URL" /> <type value="Meta" /> </parameter> <parameter> <name value="return" /> <use value="out" /> <min value="1" /> <max value="1" /> <documentation value="Resulting meta for the resource" /> <type value="Meta" /> </parameter> </OperationDefinition>
{ "resourceType": "OperationDefinition", "id": "Resource-meta-add", "meta": { "lastUpdated": "2019-11-01T09:29:23.356+11:00" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 3 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "url": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add", "version": "4.0.1", "name": "Add profiles, tags, and security labels to a resource", "status": "draft", "kind": "operation", "date": "2019-11-01T09:29:23+11:00", "publisher": "HL7 (FHIR Project)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" }, { "system": "email", "value": "fhir@lists.hl7.org" } ] } ], "description": "This operation takes a meta, and adds the profiles, tags, and security labels found in it to the nominated resource", "code": "meta-add", "resource": [ "Resource" ], "system": false, "type": false, "instance": true, "parameter": [ { "name": "meta", "use": "in", "min": 1, "max": "1", "documentation": "Profiles, tags, and security labels to add to the existing resource. Note that profiles, tags, and security labels are sets, and duplicates are not created. The identity of a tag or security label is the system+code. When matching existing tags during adding, version and display are ignored. For profiles, matching is based on the full URL", "type": "Meta" }, { "name": "return", "use": "out", "min": 1, "max": "1", "documentation": "Resulting meta for the resource", "type": "Meta" } ] }
In-Parameter
| Parameters | Resource | ||
| id | Σ | 0..1 | string |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| parameter | Σ I | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | I | 0..* | Extension |
| modifierExtension | Σ ?! I | 0..* | Extension |
| name | Σ | 1..1 | string |
| value[x] | Σ I | 0..1 | |
| valueBase64Binary | base64Binary | ||
| valueBoolean | boolean | ||
| valueCanonical | canonical() | ||
| valueCode | code | ||
| valueDate | date | ||
| valueDateTime | dateTime | ||
| valueDecimal | decimal | ||
| valueId | id | ||
| valueInstant | instant | ||
| valueInteger | integer | ||
| valueMarkdown | markdown | ||
| valueOid | oid | ||
| valuePositiveInt | positiveInt | ||
| valueString | string | ||
| valueTime | time | ||
| valueUnsignedInt | unsignedInt | ||
| valueUri | uri | ||
| valueUrl | url | ||
| valueUuid | uuid | ||
| valueAddress | Address | ||
| valueAge | Age | ||
| valueAnnotation | Annotation | ||
| valueAttachment | Attachment | ||
| valueCodeableConcept | CodeableConcept | ||
| valueCoding | Coding | ||
| valueContactPoint | ContactPoint | ||
| valueCount | Count | ||
| valueDistance | Distance | ||
| valueDuration | Duration | ||
| valueHumanName | HumanName | ||
| valueIdentifier | Identifier | ||
| valueMoney | Money | ||
| valuePeriod | Period | ||
| valueQuantity | Quantity | ||
| valueRange | Range | ||
| valueRatio | Ratio | ||
| valueSampledData | SampledData | ||
| valueSignature | Signature | ||
| valueTiming | Timing | ||
| valueContactDetail | ContactDetail | ||
| valueContributor | Contributor | ||
| valueDataRequirement | DataRequirement | ||
| valueExpression | Expression | ||
| valueParameterDefinition | ParameterDefinition | ||
| valueRelatedArtifact | RelatedArtifact | ||
| valueTriggerDefinition | TriggerDefinition | ||
| valueUsageContext | UsageContext | ||
| valueDosage | Dosage | ||
| valueMeta | Meta | ||
| valueReference | Reference() | ||
| resource | Σ I | 0..1 | Resource |
| part | Σ | 0..* | see (parameter) |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Parameters" /> <meta> <lastUpdated value="2019-11-01T09:29:23.356+11:00" /> </meta> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-category"> <valueString value="Foundation.Other" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="5" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="fhir" /> </extension> <url value="http://hl7.org/fhir/StructureDefinition/Parameters" /> <version value="4.0.1" /> <name value="Parameters" /> <status value="active" /> <date value="2019-11-01T09:29:23+11:00" /> <publisher value="Health Level Seven International (FHIR Infrastructure)" /> <contact> <telecom> <system value="url" /> <value value="http://hl7.org/fhir" /> </telecom> </contact> <contact> <telecom> <system value="url" /> <value value="http://www.hl7.org/Special/committees/fiwg/index.cfm" /> </telecom> </contact> <description value="This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it." /> <fhirVersion value="4.0.1" /> <mapping> <identity value="v2" /> <uri value="http://hl7.org/v2" /> <name value="HL7 v2 Mapping" /> </mapping> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Parameters" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Resource" /> <derivation value="specialization" /> <snapshot> <element id="Parameters"> <path value="Parameters" /> <short value="Operation Request or Response" /> <definition value="This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it." /> <comment value="The parameters that may be used are defined by the OperationDefinition resource." /> <min value="0" /> <max value="*" /> <base> <path value="Parameters" /> <min value="0" /> <max value="*" /> </base> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="Entity. Role, or Act" /> </mapping> <mapping> <identity value="v2" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Parameters.id"> <path value="Parameters.id" /> <short value="Logical id of this artifact" /> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." /> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Parameters.meta"> <path value="Parameters.meta" /> <short value="Metadata about the resource" /> <definition value="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." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.meta" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Meta" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Parameters.implicitRules"> <path value="Parameters.implicitRules" /> <short value="A set of rules under which this content was created" /> <definition value="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." /> <comment value="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." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.implicitRules" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="true" /> <isModifierReason value="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" /> <isSummary value="true" /> </element> <element id="Parameters.language"> <path value="Parameters.language" /> <short value="Language of the resource content" /> <definition value="The base language in which the resource is written." /> <comment value="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)." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.language" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="preferred" /> <description value="A human language." /> <valueSet value="http://hl7.org/fhir/ValueSet/languages" /> </binding> </element> <element id="Parameters.parameter"> <path value="Parameters.parameter" /> <short value="Operation Parameter" /> <definition value="A parameter passed to or received from the operation." /> <min value="0" /> <max value="*" /> <base> <path value="Parameters.parameter" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="inv-1" /> <severity value="error" /> <human value="A parameter must have one and only one of (value, resource, part)" /> <expression value="(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))" /> <xpath value="(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Parameters.parameter.id"> <path value="Parameters.parameter.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Parameters.parameter.extension"> <path value="Parameters.parameter.extension" /> <short value="Additional content defined by implementations" /> <definition value="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." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Parameters.parameter.modifierExtension"> <path value="Parameters.parameter.modifierExtension" /> <short value="Extensions that cannot be ignored even if unrecognized" /> <definition value="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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." /> <comment value="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." /> <requirements value="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](extensibility.html#modifierExtension)." /> <alias value="extensions" /> <alias value="user content" /> <alias value="modifiers" /> <min value="0" /> <max value="*" /> <base> <path value="BackboneElement.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="true" /> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Parameters.parameter.name"> <path value="Parameters.parameter.name" /> <short value="Name from the definition" /> <definition value="The name of the parameter (reference to the operation definition)." /> <min value="1" /> <max value="1" /> <base> <path value="Parameters.parameter.name" /> <min value="1" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Parameters.parameter.value[x]"> <path value="Parameters.parameter.value[x]" /> <short value="If parameter is a data type" /> <definition value="If the parameter is a data type." /> <min value="0" /> <max value="1" /> <base> <path value="Parameters.parameter.value[x]" /> <min value="0" /> <max value="1" /> </base> <type> <code value="base64Binary" /> </type> <type> <code value="boolean" /> </type> <type> <code value="canonical" /> </type> <type> <code value="code" /> </type> <type> <code value="date" /> </type> <type> <code value="dateTime" /> </type> <type> <code value="decimal" /> </type> <type> <code value="id" /> </type> <type> <code value="instant" /> </type> <type> <code value="integer" /> </type> <type> <code value="markdown" /> </type> <type> <code value="oid" /> </type> <type> <code value="positiveInt" /> </type> <type> <code value="string" /> </type> <type> <code value="time" /> </type> <type> <code value="unsignedInt" /> </type> <type> <code value="uri" /> </type> <type> <code value="url" /> </type> <type> <code value="uuid" /> </type> <type> <code value="Address" /> </type> <type> <code value="Age" /> </type> <type> <code value="Annotation" /> </type> <type> <code value="Attachment" /> </type> <type> <code value="CodeableConcept" /> </type> <type> <code value="Coding" /> </type> <type> <code value="ContactPoint" /> </type> <type> <code value="Count" /> </type> <type> <code value="Distance" /> </type> <type> <code value="Duration" /> </type> <type> <code value="HumanName" /> </type> <type> <code value="Identifier" /> </type> <type> <code value="Money" /> </type> <type> <code value="Period" /> </type> <type> <code value="Quantity" /> </type> <type> <code value="Range" /> </type> <type> <code value="Ratio" /> </type> <type> <code value="Reference" /> </type> <type> <code value="SampledData" /> </type> <type> <code value="Signature" /> </type> <type> <code value="Timing" /> </type> <type> <code value="ContactDetail" /> </type> <type> <code value="Contributor" /> </type> <type> <code value="DataRequirement" /> </type> <type> <code value="Expression" /> </type> <type> <code value="ParameterDefinition" /> </type> <type> <code value="RelatedArtifact" /> </type> <type> <code value="TriggerDefinition" /> </type> <type> <code value="UsageContext" /> </type> <type> <code value="Dosage" /> </type> <type> <code value="Meta" /> </type> <condition value="inv-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Parameters.parameter.resource"> <path value="Parameters.parameter.resource" /> <short value="If parameter is a whole resource" /> <definition value="If the parameter is a whole resource." /> <comment value="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." /> <min value="0" /> <max value="1" /> <base> <path value="Parameters.parameter.resource" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Resource" /> </type> <condition value="inv-1" /> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Parameters.parameter.part"> <path value="Parameters.parameter.part" /> <short value="Named part of a multi-part parameter" /> <definition value="A named part of a multi-part parameter." /> <comment value="Only one level of nested parameters is allowed." /> <min value="0" /> <max value="*" /> <base> <path value="Parameters.parameter.part" /> <min value="0" /> <max value="*" /> </base> <contentReference value="#Parameters.parameter" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> </element> </snapshot> <differential> <element id="Parameters"> <path value="Parameters" /> <short value="Operation Request or Response" /> <definition value="This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it." /> <comment value="The parameters that may be used are defined by the OperationDefinition resource." /> <min value="0" /> <max value="*" /> <mapping> <identity value="v2" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Parameters.parameter"> <path value="Parameters.parameter" /> <short value="Operation Parameter" /> <definition value="A parameter passed to or received from the operation." /> <min value="0" /> <max value="*" /> <type> <code value="BackboneElement" /> </type> <constraint> <key value="inv-1" /> <severity value="error" /> <human value="A parameter must have one and only one of (value, resource, part)" /> <expression value="(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))" /> <xpath value="(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))" /> </constraint> <isSummary value="true" /> </element> <element id="Parameters.parameter.name"> <path value="Parameters.parameter.name" /> <short value="Name from the definition" /> <definition value="The name of the parameter (reference to the operation definition)." /> <min value="1" /> <max value="1" /> <type> <code value="string" /> </type> <isSummary value="true" /> </element> <element id="Parameters.parameter.value[x]"> <path value="Parameters.parameter.value[x]" /> <short value="If parameter is a data type" /> <definition value="If the parameter is a data type." /> <min value="0" /> <max value="1" /> <type> <code value="base64Binary" /> </type> <type> <code value="boolean" /> </type> <type> <code value="canonical" /> </type> <type> <code value="code" /> </type> <type> <code value="date" /> </type> <type> <code value="dateTime" /> </type> <type> <code value="decimal" /> </type> <type> <code value="id" /> </type> <type> <code value="instant" /> </type> <type> <code value="integer" /> </type> <type> <code value="markdown" /> </type> <type> <code value="oid" /> </type> <type> <code value="positiveInt" /> </type> <type> <code value="string" /> </type> <type> <code value="time" /> </type> <type> <code value="unsignedInt" /> </type> <type> <code value="uri" /> </type> <type> <code value="url" /> </type> <type> <code value="uuid" /> </type> <type> <code value="Address" /> </type> <type> <code value="Age" /> </type> <type> <code value="Annotation" /> </type> <type> <code value="Attachment" /> </type> <type> <code value="CodeableConcept" /> </type> <type> <code value="Coding" /> </type> <type> <code value="ContactPoint" /> </type> <type> <code value="Count" /> </type> <type> <code value="Distance" /> </type> <type> <code value="Duration" /> </type> <type> <code value="HumanName" /> </type> <type> <code value="Identifier" /> </type> <type> <code value="Money" /> </type> <type> <code value="Period" /> </type> <type> <code value="Quantity" /> </type> <type> <code value="Range" /> </type> <type> <code value="Ratio" /> </type> <type> <code value="Reference" /> </type> <type> <code value="SampledData" /> </type> <type> <code value="Signature" /> </type> <type> <code value="Timing" /> </type> <type> <code value="ContactDetail" /> </type> <type> <code value="Contributor" /> </type> <type> <code value="DataRequirement" /> </type> <type> <code value="Expression" /> </type> <type> <code value="ParameterDefinition" /> </type> <type> <code value="RelatedArtifact" /> </type> <type> <code value="TriggerDefinition" /> </type> <type> <code value="UsageContext" /> </type> <type> <code value="Dosage" /> </type> <type> <code value="Meta" /> </type> <condition value="inv-1" /> <isSummary value="true" /> </element> <element id="Parameters.parameter.resource"> <path value="Parameters.parameter.resource" /> <short value="If parameter is a whole resource" /> <definition value="If the parameter is a whole resource." /> <comment value="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." /> <min value="0" /> <max value="1" /> <type> <code value="Resource" /> </type> <condition value="inv-1" /> <isSummary value="true" /> </element> <element id="Parameters.parameter.part"> <path value="Parameters.parameter.part" /> <short value="Named part of a multi-part parameter" /> <definition value="A named part of a multi-part parameter." /> <comment value="Only one level of nested parameters is allowed." /> <min value="0" /> <max value="*" /> <contentReference value="#Parameters.parameter" /> <isSummary value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "Parameters", "meta": { "lastUpdated": "2019-11-01T09:29:23.356+11:00" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category", "valueString": "Foundation.Other" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 5 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "fhir" } ], "url": "http://hl7.org/fhir/StructureDefinition/Parameters", "version": "4.0.1", "name": "Parameters", "status": "active", "date": "2019-11-01T09:29:23+11:00", "publisher": "Health Level Seven International (FHIR Infrastructure)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/fiwg/index.cfm" } ] } ], "description": "This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "resource", "abstract": false, "type": "Parameters", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Resource", "derivation": "specialization", "snapshot": { "element": [ { "id": "Parameters", "path": "Parameters", "short": "Operation Request or Response", "definition": "This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.", "comment": "The parameters that may be used are defined by the OperationDefinition resource.", "min": 0, "max": "*", "base": { "path": "Parameters", "min": 0, "max": "*" }, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ] }, { "id": "Parameters.id", "path": "Parameters.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": true }, { "id": "Parameters.meta", "path": "Parameters.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Parameters.implicitRules", "path": "Parameters.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "comment": "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.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "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", "isSummary": true }, { "id": "Parameters.language", "path": "Parameters.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "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).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages" } }, { "id": "Parameters.parameter", "path": "Parameters.parameter", "short": "Operation Parameter", "definition": "A parameter passed to or received from the operation.", "min": 0, "max": "*", "base": { "path": "Parameters.parameter", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "inv-1", "severity": "error", "human": "A parameter must have one and only one of (value, resource, part)", "expression": "(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))", "xpath": "(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))" } ], "isModifier": false, "isSummary": true }, { "id": "Parameters.parameter.id", "path": "Parameters.parameter.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Parameters.parameter.extension", "path": "Parameters.parameter.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Parameters.parameter.modifierExtension", "path": "Parameters.parameter.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "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.", "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](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Parameters.parameter.name", "path": "Parameters.parameter.name", "short": "Name from the definition", "definition": "The name of the parameter (reference to the operation definition).", "min": 1, "max": "1", "base": { "path": "Parameters.parameter.name", "min": 1, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Parameters.parameter.value[x]", "path": "Parameters.parameter.value[x]", "short": "If parameter is a data type", "definition": "If the parameter is a data type.", "min": 0, "max": "1", "base": { "path": "Parameters.parameter.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "canonical" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "url" }, { "code": "uuid" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "ContactPoint" }, { "code": "Count" }, { "code": "Distance" }, { "code": "Duration" }, { "code": "HumanName" }, { "code": "Identifier" }, { "code": "Money" }, { "code": "Period" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "Reference" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "Timing" }, { "code": "ContactDetail" }, { "code": "Contributor" }, { "code": "DataRequirement" }, { "code": "Expression" }, { "code": "ParameterDefinition" }, { "code": "RelatedArtifact" }, { "code": "TriggerDefinition" }, { "code": "UsageContext" }, { "code": "Dosage" }, { "code": "Meta" } ], "condition": [ "inv-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Parameters.parameter.resource", "path": "Parameters.parameter.resource", "short": "If parameter is a whole resource", "definition": "If the parameter is a whole resource.", "comment": "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.", "min": 0, "max": "1", "base": { "path": "Parameters.parameter.resource", "min": 0, "max": "1" }, "type": [ { "code": "Resource" } ], "condition": [ "inv-1" ], "isModifier": false, "isSummary": true }, { "id": "Parameters.parameter.part", "path": "Parameters.parameter.part", "short": "Named part of a multi-part parameter", "definition": "A named part of a multi-part parameter.", "comment": "Only one level of nested parameters is allowed.", "min": 0, "max": "*", "base": { "path": "Parameters.parameter.part", "min": 0, "max": "*" }, "contentReference": "#Parameters.parameter", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true } ] }, "differential": { "element": [ { "id": "Parameters", "path": "Parameters", "short": "Operation Request or Response", "definition": "This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.", "comment": "The parameters that may be used are defined by the OperationDefinition resource.", "min": 0, "max": "*", "mapping": [ { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ] }, { "id": "Parameters.parameter", "path": "Parameters.parameter", "short": "Operation Parameter", "definition": "A parameter passed to or received from the operation.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "inv-1", "severity": "error", "human": "A parameter must have one and only one of (value, resource, part)", "expression": "(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))", "xpath": "(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))" } ], "isSummary": true }, { "id": "Parameters.parameter.name", "path": "Parameters.parameter.name", "short": "Name from the definition", "definition": "The name of the parameter (reference to the operation definition).", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Parameters.parameter.value[x]", "path": "Parameters.parameter.value[x]", "short": "If parameter is a data type", "definition": "If the parameter is a data type.", "min": 0, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "canonical" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "url" }, { "code": "uuid" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "ContactPoint" }, { "code": "Count" }, { "code": "Distance" }, { "code": "Duration" }, { "code": "HumanName" }, { "code": "Identifier" }, { "code": "Money" }, { "code": "Period" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "Reference" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "Timing" }, { "code": "ContactDetail" }, { "code": "Contributor" }, { "code": "DataRequirement" }, { "code": "Expression" }, { "code": "ParameterDefinition" }, { "code": "RelatedArtifact" }, { "code": "TriggerDefinition" }, { "code": "UsageContext" }, { "code": "Dosage" }, { "code": "Meta" } ], "condition": [ "inv-1" ], "isSummary": true }, { "id": "Parameters.parameter.resource", "path": "Parameters.parameter.resource", "short": "If parameter is a whole resource", "definition": "If the parameter is a whole resource.", "comment": "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.", "min": 0, "max": "1", "type": [ { "code": "Resource" } ], "condition": [ "inv-1" ], "isSummary": true }, { "id": "Parameters.parameter.part", "path": "Parameters.parameter.part", "short": "Named part of a multi-part parameter", "definition": "A named part of a multi-part parameter.", "comment": "Only one level of nested parameters is allowed.", "min": 0, "max": "*", "contentReference": "#Parameters.parameter", "isSummary": true } ] } }
Beispiel
Out-Parameter
| Parameters | Resource | ||
| id | Σ | 0..1 | string |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| parameter | Σ I | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | I | 0..* | Extension |
| modifierExtension | Σ ?! I | 0..* | Extension |
| name | Σ | 1..1 | string |
| value[x] | Σ I | 0..1 | |
| valueBase64Binary | base64Binary | ||
| valueBoolean | boolean | ||
| valueCanonical | canonical() | ||
| valueCode | code | ||
| valueDate | date | ||
| valueDateTime | dateTime | ||
| valueDecimal | decimal | ||
| valueId | id | ||
| valueInstant | instant | ||
| valueInteger | integer | ||
| valueMarkdown | markdown | ||
| valueOid | oid | ||
| valuePositiveInt | positiveInt | ||
| valueString | string | ||
| valueTime | time | ||
| valueUnsignedInt | unsignedInt | ||
| valueUri | uri | ||
| valueUrl | url | ||
| valueUuid | uuid | ||
| valueAddress | Address | ||
| valueAge | Age | ||
| valueAnnotation | Annotation | ||
| valueAttachment | Attachment | ||
| valueCodeableConcept | CodeableConcept | ||
| valueCoding | Coding | ||
| valueContactPoint | ContactPoint | ||
| valueCount | Count | ||
| valueDistance | Distance | ||
| valueDuration | Duration | ||
| valueHumanName | HumanName | ||
| valueIdentifier | Identifier | ||
| valueMoney | Money | ||
| valuePeriod | Period | ||
| valueQuantity | Quantity | ||
| valueRange | Range | ||
| valueRatio | Ratio | ||
| valueSampledData | SampledData | ||
| valueSignature | Signature | ||
| valueTiming | Timing | ||
| valueContactDetail | ContactDetail | ||
| valueContributor | Contributor | ||
| valueDataRequirement | DataRequirement | ||
| valueExpression | Expression | ||
| valueParameterDefinition | ParameterDefinition | ||
| valueRelatedArtifact | RelatedArtifact | ||
| valueTriggerDefinition | TriggerDefinition | ||
| valueUsageContext | UsageContext | ||
| valueDosage | Dosage | ||
| valueMeta | Meta | ||
| valueReference | Reference() | ||
| resource | Σ I | 0..1 | Resource |
| part | Σ | 0..* | see (parameter) |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Parameters" /> <meta> <lastUpdated value="2019-11-01T09:29:23.356+11:00" /> </meta> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-category"> <valueString value="Foundation.Other" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="5" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="fhir" /> </extension> <url value="http://hl7.org/fhir/StructureDefinition/Parameters" /> <version value="4.0.1" /> <name value="Parameters" /> <status value="active" /> <date value="2019-11-01T09:29:23+11:00" /> <publisher value="Health Level Seven International (FHIR Infrastructure)" /> <contact> <telecom> <system value="url" /> <value value="http://hl7.org/fhir" /> </telecom> </contact> <contact> <telecom> <system value="url" /> <value value="http://www.hl7.org/Special/committees/fiwg/index.cfm" /> </telecom> </contact> <description value="This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it." /> <fhirVersion value="4.0.1" /> <mapping> <identity value="v2" /> <uri value="http://hl7.org/v2" /> <name value="HL7 v2 Mapping" /> </mapping> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Parameters" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Resource" /> <derivation value="specialization" /> <snapshot> <element id="Parameters"> <path value="Parameters" /> <short value="Operation Request or Response" /> <definition value="This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it." /> <comment value="The parameters that may be used are defined by the OperationDefinition resource." /> <min value="0" /> <max value="*" /> <base> <path value="Parameters" /> <min value="0" /> <max value="*" /> </base> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="Entity. Role, or Act" /> </mapping> <mapping> <identity value="v2" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Parameters.id"> <path value="Parameters.id" /> <short value="Logical id of this artifact" /> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." /> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Parameters.meta"> <path value="Parameters.meta" /> <short value="Metadata about the resource" /> <definition value="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." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.meta" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Meta" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Parameters.implicitRules"> <path value="Parameters.implicitRules" /> <short value="A set of rules under which this content was created" /> <definition value="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." /> <comment value="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." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.implicitRules" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="true" /> <isModifierReason value="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" /> <isSummary value="true" /> </element> <element id="Parameters.language"> <path value="Parameters.language" /> <short value="Language of the resource content" /> <definition value="The base language in which the resource is written." /> <comment value="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)." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.language" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="preferred" /> <description value="A human language." /> <valueSet value="http://hl7.org/fhir/ValueSet/languages" /> </binding> </element> <element id="Parameters.parameter"> <path value="Parameters.parameter" /> <short value="Operation Parameter" /> <definition value="A parameter passed to or received from the operation." /> <min value="0" /> <max value="*" /> <base> <path value="Parameters.parameter" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="inv-1" /> <severity value="error" /> <human value="A parameter must have one and only one of (value, resource, part)" /> <expression value="(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))" /> <xpath value="(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Parameters.parameter.id"> <path value="Parameters.parameter.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Parameters.parameter.extension"> <path value="Parameters.parameter.extension" /> <short value="Additional content defined by implementations" /> <definition value="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." /> <comment value="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." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Parameters.parameter.modifierExtension"> <path value="Parameters.parameter.modifierExtension" /> <short value="Extensions that cannot be ignored even if unrecognized" /> <definition value="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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." /> <comment value="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." /> <requirements value="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](extensibility.html#modifierExtension)." /> <alias value="extensions" /> <alias value="user content" /> <alias value="modifiers" /> <min value="0" /> <max value="*" /> <base> <path value="BackboneElement.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="true" /> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="Parameters.parameter.name"> <path value="Parameters.parameter.name" /> <short value="Name from the definition" /> <definition value="The name of the parameter (reference to the operation definition)." /> <min value="1" /> <max value="1" /> <base> <path value="Parameters.parameter.name" /> <min value="1" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Parameters.parameter.value[x]"> <path value="Parameters.parameter.value[x]" /> <short value="If parameter is a data type" /> <definition value="If the parameter is a data type." /> <min value="0" /> <max value="1" /> <base> <path value="Parameters.parameter.value[x]" /> <min value="0" /> <max value="1" /> </base> <type> <code value="base64Binary" /> </type> <type> <code value="boolean" /> </type> <type> <code value="canonical" /> </type> <type> <code value="code" /> </type> <type> <code value="date" /> </type> <type> <code value="dateTime" /> </type> <type> <code value="decimal" /> </type> <type> <code value="id" /> </type> <type> <code value="instant" /> </type> <type> <code value="integer" /> </type> <type> <code value="markdown" /> </type> <type> <code value="oid" /> </type> <type> <code value="positiveInt" /> </type> <type> <code value="string" /> </type> <type> <code value="time" /> </type> <type> <code value="unsignedInt" /> </type> <type> <code value="uri" /> </type> <type> <code value="url" /> </type> <type> <code value="uuid" /> </type> <type> <code value="Address" /> </type> <type> <code value="Age" /> </type> <type> <code value="Annotation" /> </type> <type> <code value="Attachment" /> </type> <type> <code value="CodeableConcept" /> </type> <type> <code value="Coding" /> </type> <type> <code value="ContactPoint" /> </type> <type> <code value="Count" /> </type> <type> <code value="Distance" /> </type> <type> <code value="Duration" /> </type> <type> <code value="HumanName" /> </type> <type> <code value="Identifier" /> </type> <type> <code value="Money" /> </type> <type> <code value="Period" /> </type> <type> <code value="Quantity" /> </type> <type> <code value="Range" /> </type> <type> <code value="Ratio" /> </type> <type> <code value="Reference" /> </type> <type> <code value="SampledData" /> </type> <type> <code value="Signature" /> </type> <type> <code value="Timing" /> </type> <type> <code value="ContactDetail" /> </type> <type> <code value="Contributor" /> </type> <type> <code value="DataRequirement" /> </type> <type> <code value="Expression" /> </type> <type> <code value="ParameterDefinition" /> </type> <type> <code value="RelatedArtifact" /> </type> <type> <code value="TriggerDefinition" /> </type> <type> <code value="UsageContext" /> </type> <type> <code value="Dosage" /> </type> <type> <code value="Meta" /> </type> <condition value="inv-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Parameters.parameter.resource"> <path value="Parameters.parameter.resource" /> <short value="If parameter is a whole resource" /> <definition value="If the parameter is a whole resource." /> <comment value="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." /> <min value="0" /> <max value="1" /> <base> <path value="Parameters.parameter.resource" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Resource" /> </type> <condition value="inv-1" /> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="Parameters.parameter.part"> <path value="Parameters.parameter.part" /> <short value="Named part of a multi-part parameter" /> <definition value="A named part of a multi-part parameter." /> <comment value="Only one level of nested parameters is allowed." /> <min value="0" /> <max value="*" /> <base> <path value="Parameters.parameter.part" /> <min value="0" /> <max value="*" /> </base> <contentReference value="#Parameters.parameter" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> </element> </snapshot> <differential> <element id="Parameters"> <path value="Parameters" /> <short value="Operation Request or Response" /> <definition value="This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it." /> <comment value="The parameters that may be used are defined by the OperationDefinition resource." /> <min value="0" /> <max value="*" /> <mapping> <identity value="v2" /> <map value="n/a" /> </mapping> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="Parameters.parameter"> <path value="Parameters.parameter" /> <short value="Operation Parameter" /> <definition value="A parameter passed to or received from the operation." /> <min value="0" /> <max value="*" /> <type> <code value="BackboneElement" /> </type> <constraint> <key value="inv-1" /> <severity value="error" /> <human value="A parameter must have one and only one of (value, resource, part)" /> <expression value="(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))" /> <xpath value="(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))" /> </constraint> <isSummary value="true" /> </element> <element id="Parameters.parameter.name"> <path value="Parameters.parameter.name" /> <short value="Name from the definition" /> <definition value="The name of the parameter (reference to the operation definition)." /> <min value="1" /> <max value="1" /> <type> <code value="string" /> </type> <isSummary value="true" /> </element> <element id="Parameters.parameter.value[x]"> <path value="Parameters.parameter.value[x]" /> <short value="If parameter is a data type" /> <definition value="If the parameter is a data type." /> <min value="0" /> <max value="1" /> <type> <code value="base64Binary" /> </type> <type> <code value="boolean" /> </type> <type> <code value="canonical" /> </type> <type> <code value="code" /> </type> <type> <code value="date" /> </type> <type> <code value="dateTime" /> </type> <type> <code value="decimal" /> </type> <type> <code value="id" /> </type> <type> <code value="instant" /> </type> <type> <code value="integer" /> </type> <type> <code value="markdown" /> </type> <type> <code value="oid" /> </type> <type> <code value="positiveInt" /> </type> <type> <code value="string" /> </type> <type> <code value="time" /> </type> <type> <code value="unsignedInt" /> </type> <type> <code value="uri" /> </type> <type> <code value="url" /> </type> <type> <code value="uuid" /> </type> <type> <code value="Address" /> </type> <type> <code value="Age" /> </type> <type> <code value="Annotation" /> </type> <type> <code value="Attachment" /> </type> <type> <code value="CodeableConcept" /> </type> <type> <code value="Coding" /> </type> <type> <code value="ContactPoint" /> </type> <type> <code value="Count" /> </type> <type> <code value="Distance" /> </type> <type> <code value="Duration" /> </type> <type> <code value="HumanName" /> </type> <type> <code value="Identifier" /> </type> <type> <code value="Money" /> </type> <type> <code value="Period" /> </type> <type> <code value="Quantity" /> </type> <type> <code value="Range" /> </type> <type> <code value="Ratio" /> </type> <type> <code value="Reference" /> </type> <type> <code value="SampledData" /> </type> <type> <code value="Signature" /> </type> <type> <code value="Timing" /> </type> <type> <code value="ContactDetail" /> </type> <type> <code value="Contributor" /> </type> <type> <code value="DataRequirement" /> </type> <type> <code value="Expression" /> </type> <type> <code value="ParameterDefinition" /> </type> <type> <code value="RelatedArtifact" /> </type> <type> <code value="TriggerDefinition" /> </type> <type> <code value="UsageContext" /> </type> <type> <code value="Dosage" /> </type> <type> <code value="Meta" /> </type> <condition value="inv-1" /> <isSummary value="true" /> </element> <element id="Parameters.parameter.resource"> <path value="Parameters.parameter.resource" /> <short value="If parameter is a whole resource" /> <definition value="If the parameter is a whole resource." /> <comment value="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." /> <min value="0" /> <max value="1" /> <type> <code value="Resource" /> </type> <condition value="inv-1" /> <isSummary value="true" /> </element> <element id="Parameters.parameter.part"> <path value="Parameters.parameter.part" /> <short value="Named part of a multi-part parameter" /> <definition value="A named part of a multi-part parameter." /> <comment value="Only one level of nested parameters is allowed." /> <min value="0" /> <max value="*" /> <contentReference value="#Parameters.parameter" /> <isSummary value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "Parameters", "meta": { "lastUpdated": "2019-11-01T09:29:23.356+11:00" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category", "valueString": "Foundation.Other" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 5 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "fhir" } ], "url": "http://hl7.org/fhir/StructureDefinition/Parameters", "version": "4.0.1", "name": "Parameters", "status": "active", "date": "2019-11-01T09:29:23+11:00", "publisher": "Health Level Seven International (FHIR Infrastructure)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/fiwg/index.cfm" } ] } ], "description": "This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "resource", "abstract": false, "type": "Parameters", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Resource", "derivation": "specialization", "snapshot": { "element": [ { "id": "Parameters", "path": "Parameters", "short": "Operation Request or Response", "definition": "This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.", "comment": "The parameters that may be used are defined by the OperationDefinition resource.", "min": 0, "max": "*", "base": { "path": "Parameters", "min": 0, "max": "*" }, "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ] }, { "id": "Parameters.id", "path": "Parameters.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": true }, { "id": "Parameters.meta", "path": "Parameters.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Parameters.implicitRules", "path": "Parameters.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "comment": "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.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "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", "isSummary": true }, { "id": "Parameters.language", "path": "Parameters.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "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).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages" } }, { "id": "Parameters.parameter", "path": "Parameters.parameter", "short": "Operation Parameter", "definition": "A parameter passed to or received from the operation.", "min": 0, "max": "*", "base": { "path": "Parameters.parameter", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "inv-1", "severity": "error", "human": "A parameter must have one and only one of (value, resource, part)", "expression": "(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))", "xpath": "(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))" } ], "isModifier": false, "isSummary": true }, { "id": "Parameters.parameter.id", "path": "Parameters.parameter.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Parameters.parameter.extension", "path": "Parameters.parameter.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Parameters.parameter.modifierExtension", "path": "Parameters.parameter.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "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.", "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](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Parameters.parameter.name", "path": "Parameters.parameter.name", "short": "Name from the definition", "definition": "The name of the parameter (reference to the operation definition).", "min": 1, "max": "1", "base": { "path": "Parameters.parameter.name", "min": 1, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Parameters.parameter.value[x]", "path": "Parameters.parameter.value[x]", "short": "If parameter is a data type", "definition": "If the parameter is a data type.", "min": 0, "max": "1", "base": { "path": "Parameters.parameter.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "canonical" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "url" }, { "code": "uuid" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "ContactPoint" }, { "code": "Count" }, { "code": "Distance" }, { "code": "Duration" }, { "code": "HumanName" }, { "code": "Identifier" }, { "code": "Money" }, { "code": "Period" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "Reference" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "Timing" }, { "code": "ContactDetail" }, { "code": "Contributor" }, { "code": "DataRequirement" }, { "code": "Expression" }, { "code": "ParameterDefinition" }, { "code": "RelatedArtifact" }, { "code": "TriggerDefinition" }, { "code": "UsageContext" }, { "code": "Dosage" }, { "code": "Meta" } ], "condition": [ "inv-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "Parameters.parameter.resource", "path": "Parameters.parameter.resource", "short": "If parameter is a whole resource", "definition": "If the parameter is a whole resource.", "comment": "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.", "min": 0, "max": "1", "base": { "path": "Parameters.parameter.resource", "min": 0, "max": "1" }, "type": [ { "code": "Resource" } ], "condition": [ "inv-1" ], "isModifier": false, "isSummary": true }, { "id": "Parameters.parameter.part", "path": "Parameters.parameter.part", "short": "Named part of a multi-part parameter", "definition": "A named part of a multi-part parameter.", "comment": "Only one level of nested parameters is allowed.", "min": 0, "max": "*", "base": { "path": "Parameters.parameter.part", "min": 0, "max": "*" }, "contentReference": "#Parameters.parameter", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true } ] }, "differential": { "element": [ { "id": "Parameters", "path": "Parameters", "short": "Operation Request or Response", "definition": "This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.", "comment": "The parameters that may be used are defined by the OperationDefinition resource.", "min": 0, "max": "*", "mapping": [ { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ] }, { "id": "Parameters.parameter", "path": "Parameters.parameter", "short": "Operation Parameter", "definition": "A parameter passed to or received from the operation.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "inv-1", "severity": "error", "human": "A parameter must have one and only one of (value, resource, part)", "expression": "(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))", "xpath": "(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))" } ], "isSummary": true }, { "id": "Parameters.parameter.name", "path": "Parameters.parameter.name", "short": "Name from the definition", "definition": "The name of the parameter (reference to the operation definition).", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "Parameters.parameter.value[x]", "path": "Parameters.parameter.value[x]", "short": "If parameter is a data type", "definition": "If the parameter is a data type.", "min": 0, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "canonical" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "url" }, { "code": "uuid" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "ContactPoint" }, { "code": "Count" }, { "code": "Distance" }, { "code": "Duration" }, { "code": "HumanName" }, { "code": "Identifier" }, { "code": "Money" }, { "code": "Period" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "Reference" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "Timing" }, { "code": "ContactDetail" }, { "code": "Contributor" }, { "code": "DataRequirement" }, { "code": "Expression" }, { "code": "ParameterDefinition" }, { "code": "RelatedArtifact" }, { "code": "TriggerDefinition" }, { "code": "UsageContext" }, { "code": "Dosage" }, { "code": "Meta" } ], "condition": [ "inv-1" ], "isSummary": true }, { "id": "Parameters.parameter.resource", "path": "Parameters.parameter.resource", "short": "If parameter is a whole resource", "definition": "If the parameter is a whole resource.", "comment": "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.", "min": 0, "max": "1", "type": [ { "code": "Resource" } ], "condition": [ "inv-1" ], "isSummary": true }, { "id": "Parameters.parameter.part", "path": "Parameters.parameter.part", "short": "Named part of a multi-part parameter", "definition": "A named part of a multi-part parameter.", "comment": "Only one level of nested parameters is allowed.", "min": 0, "max": "*", "contentReference": "#Parameters.parameter", "isSummary": true } ] } }