Extensions for Using Data Elements from FHIR R4 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4_OperationDefinition_R4B

Official URL: http://hl7.org/fhir/4.0/StructureDefinition/profile-OperationDefinition Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4_OperationDefinition_R4B

This cross-version profile allows R4 OperationDefinition content to be represented via FHIR R4B OperationDefinition resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition C 0..* OperationDefinition(4.3.0) Definition of an operation or a named query
Constraints: opd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... name Σ 1..1 string Name for this operation definition (computer friendly)
... kind Σ 1..1 code operation | query
Binding: OperationKind (required): Whether an operation is a normal operation or a query.
... code Σ 1..1 code Name used to invoke the operation
... system Σ 1..1 boolean Invoke at the system level?
... type Σ 1..1 boolean Invoke at the type level?
... instance Σ 1..1 boolean Invoke on an instance?

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
OperationDefinition.​status Base required PublicationStatus 📍4.3.0 FHIR Std.
OperationDefinition.​kind Base required OperationKind 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error OperationDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error OperationDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error OperationDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error OperationDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice OperationDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error OperationDefinition.implicitRules, OperationDefinition.modifierExtension, OperationDefinition.name, OperationDefinition.status, OperationDefinition.kind, OperationDefinition.code, OperationDefinition.system, OperationDefinition.type, OperationDefinition.instance All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error OperationDefinition.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
opd-0 warning OperationDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

This structure is derived from OperationDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition 0..* OperationDefinition(4.3.0) Definition of an operation or a named query
... resource
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:resource 0..* code ​R4: resource
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-OperationDefinition.resource
Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-resource-types-for-R4B (required): One of the resource types defined as part of this version of FHIR.
... parameter
.... type
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..1 code ​R4: type
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-OperationDefinition.parameter.type
Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-all-types-for-R4B (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition C 0..* OperationDefinition(4.3.0) Definition of an operation or a named query
Constraints: opd-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 0..1 uri Canonical identifier for this operation definition, represented as a URI (globally unique)
... version Σ 0..1 string Business version of the operation definition
... name Σ 1..1 string Name for this operation definition (computer friendly)
... title Σ 0..1 string Name for this operation definition (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... kind Σ 1..1 code operation | query
Binding: OperationKind (required): Whether an operation is a normal operation or a query.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the operation definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for operation definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this operation definition is defined
... affectsState Σ 0..1 boolean Whether content is changed by the operation
... code Σ 1..1 code Name used to invoke the operation
... comment 0..1 markdown Additional information about use
... base Σ 0..1 canonical(OperationDefinition) Marks this as a profile of the base
... resource Σ 0..* code Types this operation applies to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:resource 0..* code ​R4: resource
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-OperationDefinition.resource
Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-resource-types-for-R4B (required): One of the resource types defined as part of this version of FHIR.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... system Σ 1..1 boolean Invoke at the system level?
... type Σ 1..1 boolean Invoke at the type level?
... instance Σ 1..1 boolean Invoke on an instance?
... inputProfile 0..1 canonical(StructureDefinition) Validation information for in parameters
... outputProfile 0..1 canonical(StructureDefinition) Validation information for out parameters
... parameter C 0..* BackboneElement Parameters for the operation/query
Constraints: opd-1, opd-2, opd-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... name 1..1 code Name in Parameters.parameter.name or in URL
.... use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
.... min 1..1 integer Minimum Cardinality
.... max 1..1 string Maximum Cardinality (a number or *)
.... documentation 0..1 string Description of meaning/use
.... type C 0..1 code What type this parameter has
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 0..1 code ​R4: type
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-OperationDefinition.parameter.type
Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-all-types-for-R4B (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Constraints: ext-1
..... value 0..1 code Primitive value for code
.... targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets
.... searchType C 0..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
.... binding 0..1 BackboneElement ValueSet details if this is coded
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... strength 1..1 code required | extensible | preferred | example
Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding.
..... valueSet 1..1 canonical(ValueSet) Source of value set
.... referencedFrom 0..* BackboneElement References to this parameter
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... source 1..1 string Referencing parameter
..... sourceId 0..1 string Element id of reference
.... part C 0..* See parameter (OperationDefinition) Parts of a nested Parameter
... overload 0..* BackboneElement Define overloaded variants for when generating code
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... parameterName 0..* string Name of parameter to include in overload
.... comment 0..1 string Comments to go on overload

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
OperationDefinition.​language Base preferred Common Languages 📍4.3.0 FHIR Std.
OperationDefinition.​status Base required PublicationStatus 📍4.3.0 FHIR Std.
OperationDefinition.​kind Base required OperationKind 📍4.3.0 FHIR Std.
OperationDefinition.​jurisdiction Base extensible Jurisdiction 📍4.3.0 FHIR Std.
OperationDefinition.​resource Base required ResourceType 📍4.3.0 FHIR Std.
OperationDefinition.​parameter.use Base required OperationParameterUse 📍4.3.0 FHIR Std.
OperationDefinition.​parameter.type Base required FHIRAllTypes 📍4.3.0 FHIR Std.
OperationDefinition.​parameter.searchType Base required SearchParamType 📍4.3.0 FHIR Std.
OperationDefinition.​parameter.binding.strength Base required BindingStrength 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error OperationDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error OperationDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error OperationDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error OperationDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice OperationDefinition A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning OperationDefinition.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error OperationDefinition.meta, OperationDefinition.implicitRules, OperationDefinition.language, OperationDefinition.text, OperationDefinition.extension, OperationDefinition.modifierExtension, OperationDefinition.url, OperationDefinition.version, OperationDefinition.name, OperationDefinition.title, OperationDefinition.status, OperationDefinition.kind, OperationDefinition.experimental, OperationDefinition.date, OperationDefinition.publisher, OperationDefinition.contact, OperationDefinition.description, OperationDefinition.useContext, OperationDefinition.jurisdiction, OperationDefinition.purpose, OperationDefinition.affectsState, OperationDefinition.code, OperationDefinition.comment, OperationDefinition.base, OperationDefinition.resource, OperationDefinition.resource.extension, OperationDefinition.resource.extension:resource, OperationDefinition.system, OperationDefinition.type, OperationDefinition.instance, OperationDefinition.inputProfile, OperationDefinition.outputProfile, OperationDefinition.parameter, OperationDefinition.parameter.extension, OperationDefinition.parameter.modifierExtension, OperationDefinition.parameter.name, OperationDefinition.parameter.use, OperationDefinition.parameter.min, OperationDefinition.parameter.max, OperationDefinition.parameter.documentation, OperationDefinition.parameter.type, OperationDefinition.parameter.type.extension, OperationDefinition.parameter.type.extension:type, OperationDefinition.parameter.targetProfile, OperationDefinition.parameter.searchType, OperationDefinition.parameter.binding, OperationDefinition.parameter.binding.extension, OperationDefinition.parameter.binding.modifierExtension, OperationDefinition.parameter.binding.strength, OperationDefinition.parameter.binding.valueSet, OperationDefinition.parameter.referencedFrom, OperationDefinition.parameter.referencedFrom.extension, OperationDefinition.parameter.referencedFrom.modifierExtension, OperationDefinition.parameter.referencedFrom.source, OperationDefinition.parameter.referencedFrom.sourceId, OperationDefinition.parameter.part, OperationDefinition.overload, OperationDefinition.overload.extension, OperationDefinition.overload.modifierExtension, OperationDefinition.overload.parameterName, OperationDefinition.overload.comment All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error OperationDefinition.extension, OperationDefinition.modifierExtension, OperationDefinition.resource.extension, OperationDefinition.resource.extension:resource, OperationDefinition.parameter.extension, OperationDefinition.parameter.modifierExtension, OperationDefinition.parameter.type.extension, OperationDefinition.parameter.type.extension:type, OperationDefinition.parameter.binding.extension, OperationDefinition.parameter.binding.modifierExtension, OperationDefinition.parameter.referencedFrom.extension, OperationDefinition.parameter.referencedFrom.modifierExtension, OperationDefinition.overload.extension, OperationDefinition.overload.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
opd-0 warning OperationDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
opd-1 error OperationDefinition.parameter Either a type must be provided, or parts type.exists() or part.exists()
opd-2 error OperationDefinition.parameter A search type can only be specified for parameters of type string searchType.exists() implies type = 'string'
opd-3 error OperationDefinition.parameter A targetProfile can only be specified for parameters of type Reference or Canonical targetProfile.exists() implies (type = 'Reference' or type = 'canonical')

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition C 0..* OperationDefinition(4.3.0) Definition of an operation or a named query
Constraints: opd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... name Σ 1..1 string Name for this operation definition (computer friendly)
... kind Σ 1..1 code operation | query
Binding: OperationKind (required): Whether an operation is a normal operation or a query.
... code Σ 1..1 code Name used to invoke the operation
... system Σ 1..1 boolean Invoke at the system level?
... type Σ 1..1 boolean Invoke at the type level?
... instance Σ 1..1 boolean Invoke on an instance?

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
OperationDefinition.​status Base required PublicationStatus 📍4.3.0 FHIR Std.
OperationDefinition.​kind Base required OperationKind 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error OperationDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error OperationDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error OperationDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error OperationDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice OperationDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error OperationDefinition.implicitRules, OperationDefinition.modifierExtension, OperationDefinition.name, OperationDefinition.status, OperationDefinition.kind, OperationDefinition.code, OperationDefinition.system, OperationDefinition.type, OperationDefinition.instance All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error OperationDefinition.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
opd-0 warning OperationDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Differential View

This structure is derived from OperationDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition 0..* OperationDefinition(4.3.0) Definition of an operation or a named query
... resource
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:resource 0..* code ​R4: resource
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-OperationDefinition.resource
Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-resource-types-for-R4B (required): One of the resource types defined as part of this version of FHIR.
... parameter
.... type
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..1 code ​R4: type
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-OperationDefinition.parameter.type
Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-all-types-for-R4B (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition C 0..* OperationDefinition(4.3.0) Definition of an operation or a named query
Constraints: opd-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 0..1 uri Canonical identifier for this operation definition, represented as a URI (globally unique)
... version Σ 0..1 string Business version of the operation definition
... name Σ 1..1 string Name for this operation definition (computer friendly)
... title Σ 0..1 string Name for this operation definition (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... kind Σ 1..1 code operation | query
Binding: OperationKind (required): Whether an operation is a normal operation or a query.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the operation definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for operation definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this operation definition is defined
... affectsState Σ 0..1 boolean Whether content is changed by the operation
... code Σ 1..1 code Name used to invoke the operation
... comment 0..1 markdown Additional information about use
... base Σ 0..1 canonical(OperationDefinition) Marks this as a profile of the base
... resource Σ 0..* code Types this operation applies to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:resource 0..* code ​R4: resource
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-OperationDefinition.resource
Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-resource-types-for-R4B (required): One of the resource types defined as part of this version of FHIR.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... system Σ 1..1 boolean Invoke at the system level?
... type Σ 1..1 boolean Invoke at the type level?
... instance Σ 1..1 boolean Invoke on an instance?
... inputProfile 0..1 canonical(StructureDefinition) Validation information for in parameters
... outputProfile 0..1 canonical(StructureDefinition) Validation information for out parameters
... parameter C 0..* BackboneElement Parameters for the operation/query
Constraints: opd-1, opd-2, opd-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... name 1..1 code Name in Parameters.parameter.name or in URL
.... use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
.... min 1..1 integer Minimum Cardinality
.... max 1..1 string Maximum Cardinality (a number or *)
.... documentation 0..1 string Description of meaning/use
.... type C 0..1 code What type this parameter has
Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 0..1 code ​R4: type
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-OperationDefinition.parameter.type
Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-all-types-for-R4B (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
Constraints: ext-1
..... value 0..1 code Primitive value for code
.... targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets
.... searchType C 0..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
.... binding 0..1 BackboneElement ValueSet details if this is coded
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... strength 1..1 code required | extensible | preferred | example
Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding.
..... valueSet 1..1 canonical(ValueSet) Source of value set
.... referencedFrom 0..* BackboneElement References to this parameter
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... source 1..1 string Referencing parameter
..... sourceId 0..1 string Element id of reference
.... part C 0..* See parameter (OperationDefinition) Parts of a nested Parameter
... overload 0..* BackboneElement Define overloaded variants for when generating code
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... parameterName 0..* string Name of parameter to include in overload
.... comment 0..1 string Comments to go on overload

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
OperationDefinition.​language Base preferred Common Languages 📍4.3.0 FHIR Std.
OperationDefinition.​status Base required PublicationStatus 📍4.3.0 FHIR Std.
OperationDefinition.​kind Base required OperationKind 📍4.3.0 FHIR Std.
OperationDefinition.​jurisdiction Base extensible Jurisdiction 📍4.3.0 FHIR Std.
OperationDefinition.​resource Base required ResourceType 📍4.3.0 FHIR Std.
OperationDefinition.​parameter.use Base required OperationParameterUse 📍4.3.0 FHIR Std.
OperationDefinition.​parameter.type Base required FHIRAllTypes 📍4.3.0 FHIR Std.
OperationDefinition.​parameter.searchType Base required SearchParamType 📍4.3.0 FHIR Std.
OperationDefinition.​parameter.binding.strength Base required BindingStrength 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error OperationDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error OperationDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error OperationDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error OperationDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice OperationDefinition A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning OperationDefinition.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error OperationDefinition.meta, OperationDefinition.implicitRules, OperationDefinition.language, OperationDefinition.text, OperationDefinition.extension, OperationDefinition.modifierExtension, OperationDefinition.url, OperationDefinition.version, OperationDefinition.name, OperationDefinition.title, OperationDefinition.status, OperationDefinition.kind, OperationDefinition.experimental, OperationDefinition.date, OperationDefinition.publisher, OperationDefinition.contact, OperationDefinition.description, OperationDefinition.useContext, OperationDefinition.jurisdiction, OperationDefinition.purpose, OperationDefinition.affectsState, OperationDefinition.code, OperationDefinition.comment, OperationDefinition.base, OperationDefinition.resource, OperationDefinition.resource.extension, OperationDefinition.resource.extension:resource, OperationDefinition.system, OperationDefinition.type, OperationDefinition.instance, OperationDefinition.inputProfile, OperationDefinition.outputProfile, OperationDefinition.parameter, OperationDefinition.parameter.extension, OperationDefinition.parameter.modifierExtension, OperationDefinition.parameter.name, OperationDefinition.parameter.use, OperationDefinition.parameter.min, OperationDefinition.parameter.max, OperationDefinition.parameter.documentation, OperationDefinition.parameter.type, OperationDefinition.parameter.type.extension, OperationDefinition.parameter.type.extension:type, OperationDefinition.parameter.targetProfile, OperationDefinition.parameter.searchType, OperationDefinition.parameter.binding, OperationDefinition.parameter.binding.extension, OperationDefinition.parameter.binding.modifierExtension, OperationDefinition.parameter.binding.strength, OperationDefinition.parameter.binding.valueSet, OperationDefinition.parameter.referencedFrom, OperationDefinition.parameter.referencedFrom.extension, OperationDefinition.parameter.referencedFrom.modifierExtension, OperationDefinition.parameter.referencedFrom.source, OperationDefinition.parameter.referencedFrom.sourceId, OperationDefinition.parameter.part, OperationDefinition.overload, OperationDefinition.overload.extension, OperationDefinition.overload.modifierExtension, OperationDefinition.overload.parameterName, OperationDefinition.overload.comment All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error OperationDefinition.extension, OperationDefinition.modifierExtension, OperationDefinition.resource.extension, OperationDefinition.resource.extension:resource, OperationDefinition.parameter.extension, OperationDefinition.parameter.modifierExtension, OperationDefinition.parameter.type.extension, OperationDefinition.parameter.type.extension:type, OperationDefinition.parameter.binding.extension, OperationDefinition.parameter.binding.modifierExtension, OperationDefinition.parameter.referencedFrom.extension, OperationDefinition.parameter.referencedFrom.modifierExtension, OperationDefinition.overload.extension, OperationDefinition.overload.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
opd-0 warning OperationDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
opd-1 error OperationDefinition.parameter Either a type must be provided, or parts type.exists() or part.exists()
opd-2 error OperationDefinition.parameter A search type can only be specified for parameters of type string searchType.exists() implies type = 'string'
opd-3 error OperationDefinition.parameter A targetProfile can only be specified for parameters of type Reference or Canonical targetProfile.exists() implies (type = 'Reference' or type = 'canonical')

 

Other representations of profile: CSV, Excel, Schematron