Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CRMI Operation Profile: Pageable

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-pageable-operation Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: PageableOperation
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.10

Operation that is pageable

This establishes input parameters when the operation might return paging.

  • offset: Pagination offset
  • count: Number of items per page

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
OperationDefinition C 0..* OperationDefinition Definition of an operation or a named query
Constraints: opd-0
OperationDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
OperationDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
OperationDefinition.name This element is included in summaries. C 1..1 string Name for this operation definition (computer friendly)
OperationDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
OperationDefinition.kind This element is included in summaries. 1..1 code operation | query
Binding: OperationKind (required): Whether an operation is a normal operation or a query.
OperationDefinition.code This element is included in summaries. 1..1 code Name used to invoke the operation
OperationDefinition.system This element is included in summaries. 1..1 boolean Invoke at the system level?
OperationDefinition.type This element is included in summaries. 1..1 boolean Invoke at the type level?
OperationDefinition.instance This element is included in summaries. 1..1 boolean Invoke on an instance?
OperationDefinition.Slices for parameter C 0..* BackboneElement Parameters for the operation/query
Slice: Unordered, Open by value:name
Constraints: opd-1, opd-2, opd-3
OperationDefinition.Slices for parameter.parameter:All Slices Content/Rules for all slices
OperationDefinition.Slices for parameter.parameter:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:All Slices.name 1..1 code Name in Parameters.parameter.name or in URL
OperationDefinition.Slices for parameter.parameter:All Slices.use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
OperationDefinition.Slices for parameter.parameter:All Slices.min 1..1 integer Minimum Cardinality
OperationDefinition.Slices for parameter.parameter:All Slices.max 1..1 string Maximum Cardinality (a number or *)
OperationDefinition.Slices for parameter.parameter:offset This element must be supported. C 0..1 BackboneElement Parameters for the operation/query
Constraints: opd-1, opd-2, opd-3
OperationDefinition.Slices for parameter.parameter:offset.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:offset.name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: offset (no extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
Required Pattern: in (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.min 1..1 integer Minimum Cardinality
Required Pattern: 0 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: 1 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.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.
Required Pattern: integer (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count This element must be supported. C 0..1 BackboneElement Parameters for the operation/query
Constraints: opd-1, opd-2, opd-3
OperationDefinition.Slices for parameter.parameter:count.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:count.name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: count (no extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
Required Pattern: in (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.min 1..1 integer Minimum Cardinality
Required Pattern: 0 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: 1 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.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.
Required Pattern: integer (extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
OperationDefinition.​status Base required PublicationStatus 📍4.0.1 FHIR Std.
OperationDefinition.​kind Base required OperationKind 📍4.0.1 FHIR Std.
OperationDefinition.​parameter.use Base required OperationParameterUse 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:offset.use Base required OperationParameterUse 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:offset.type Base required FHIRAllTypes 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:count.use Base required OperationParameterUse 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:count.type Base required FHIRAllTypes 📍4.0.1 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 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(canonical) = '#').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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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.matches('[A-Z]([A-Za-z0-9_]){0,254}')
opd-1 error OperationDefinition.parameter, OperationDefinition.parameter:offset, OperationDefinition.parameter:count Either a type must be provided, or parts type.exists() or part.exists()
opd-2 error OperationDefinition.parameter, OperationDefinition.parameter:offset, OperationDefinition.parameter:count A search type can only be specified for parameters of type string searchType.exists() implies type = 'string'
opd-3 error OperationDefinition.parameter, OperationDefinition.parameter:offset, OperationDefinition.parameter:count A targetProfile can only be specified for parameters of type Reference or Canonical targetProfile.exists() implies (type = 'Reference' or type = 'canonical')

This structure is derived from OperationDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
OperationDefinition 0..* OperationDefinition Definition of an operation or a named query
OperationDefinition.Slices for parameter 0..* BackboneElement Parameters for the operation/query
Slice: Unordered, Open by value:name
OperationDefinition.Slices for parameter.parameter:offset This element must be supported. 0..1 BackboneElement Parameters for the operation/query
OperationDefinition.Slices for parameter.parameter:offset.name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: offset (no extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.use 1..1 code in | out
Required Pattern: in (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.min 1..1 integer Minimum Cardinality
Required Pattern: 0 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: 1 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.type 0..1 code What type this parameter has
Required Pattern: integer (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count This element must be supported. 0..1 BackboneElement Parameters for the operation/query
OperationDefinition.Slices for parameter.parameter:count.name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: count (no extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.use 1..1 code in | out
Required Pattern: in (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.min 1..1 integer Minimum Cardinality
Required Pattern: 0 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: 1 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.type 0..1 code What type this parameter has
Required Pattern: integer (extensions allowed)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
OperationDefinition C 0..* OperationDefinition Definition of an operation or a named query
Constraints: opd-0
OperationDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
OperationDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
OperationDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
OperationDefinition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
OperationDefinition.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
OperationDefinition.contained 0..* Resource Contained, inline Resources
OperationDefinition.extension 0..* Extension Additional content defined by implementations
OperationDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
OperationDefinition.url This element is included in summaries. 0..1 uri Canonical identifier for this operation definition, represented as a URI (globally unique)
OperationDefinition.version This element is included in summaries. 0..1 string Business version of the operation definition
OperationDefinition.name This element is included in summaries. C 1..1 string Name for this operation definition (computer friendly)
OperationDefinition.title This element is included in summaries. 0..1 string Name for this operation definition (human friendly)
OperationDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
OperationDefinition.kind This element is included in summaries. 1..1 code operation | query
Binding: OperationKind (required): Whether an operation is a normal operation or a query.
OperationDefinition.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
OperationDefinition.date This element is included in summaries. 0..1 dateTime Date last changed
OperationDefinition.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
OperationDefinition.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
OperationDefinition.description 0..1 markdown Natural language description of the operation definition
OperationDefinition.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
OperationDefinition.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for operation definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
OperationDefinition.purpose 0..1 markdown Why this operation definition is defined
OperationDefinition.affectsState This element is included in summaries. 0..1 boolean Whether content is changed by the operation
OperationDefinition.code This element is included in summaries. 1..1 code Name used to invoke the operation
OperationDefinition.comment 0..1 markdown Additional information about use
OperationDefinition.base This element is included in summaries. 0..1 canonical(OperationDefinition) Marks this as a profile of the base
OperationDefinition.resource This element is included in summaries. 0..* code Types this operation applies to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
OperationDefinition.system This element is included in summaries. 1..1 boolean Invoke at the system level?
OperationDefinition.type This element is included in summaries. 1..1 boolean Invoke at the type level?
OperationDefinition.instance This element is included in summaries. 1..1 boolean Invoke on an instance?
OperationDefinition.inputProfile 0..1 canonical(StructureDefinition) Validation information for in parameters
OperationDefinition.outputProfile 0..1 canonical(StructureDefinition) Validation information for out parameters
OperationDefinition.Slices for parameter C 0..* BackboneElement Parameters for the operation/query
Slice: Unordered, Open by value:name
Constraints: opd-1, opd-2, opd-3
OperationDefinition.Slices for parameter.parameter:All Slices Content/Rules for all slices
OperationDefinition.Slices for parameter.parameter:All Slices.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:All Slices.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:All Slices.name 1..1 code Name in Parameters.parameter.name or in URL
OperationDefinition.Slices for parameter.parameter:All Slices.use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
OperationDefinition.Slices for parameter.parameter:All Slices.min 1..1 integer Minimum Cardinality
OperationDefinition.Slices for parameter.parameter:All Slices.max 1..1 string Maximum Cardinality (a number or *)
OperationDefinition.Slices for parameter.parameter:All Slices.documentation 0..1 string Description of meaning/use
OperationDefinition.Slices for parameter.parameter:All Slices.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.
OperationDefinition.Slices for parameter.parameter:All Slices.targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets
OperationDefinition.Slices for parameter.parameter:All Slices.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.
OperationDefinition.Slices for parameter.parameter:All Slices.binding 0..1 BackboneElement ValueSet details if this is coded
OperationDefinition.Slices for parameter.parameter:All Slices.binding.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:All Slices.binding.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:All Slices.binding.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:All Slices.binding.strength 1..1 code required | extensible | preferred | example
Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding.
OperationDefinition.Slices for parameter.parameter:All Slices.binding.valueSet 1..1 canonical(ValueSet) Source of value set
OperationDefinition.Slices for parameter.parameter:All Slices.referencedFrom 0..* BackboneElement References to this parameter
OperationDefinition.Slices for parameter.parameter:All Slices.referencedFrom.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:All Slices.referencedFrom.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:All Slices.referencedFrom.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:All Slices.referencedFrom.source 1..1 string Referencing parameter
OperationDefinition.Slices for parameter.parameter:All Slices.referencedFrom.sourceId 0..1 string Element id of reference
OperationDefinition.Slices for parameter.parameter:All Slices.part C 0..* See parameter (OperationDefinition) Parts of a nested Parameter
OperationDefinition.Slices for parameter.parameter:offset This element must be supported. C 0..1 BackboneElement Parameters for the operation/query
Constraints: opd-1, opd-2, opd-3
OperationDefinition.Slices for parameter.parameter:offset.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:offset.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:offset.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:offset.name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: offset (no extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
Required Pattern: in (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.min 1..1 integer Minimum Cardinality
Required Pattern: 0 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: 1 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.documentation 0..1 string Description of meaning/use
OperationDefinition.Slices for parameter.parameter:offset.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.
Required Pattern: integer (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets
OperationDefinition.Slices for parameter.parameter:offset.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.
OperationDefinition.Slices for parameter.parameter:offset.binding 0..1 BackboneElement ValueSet details if this is coded
OperationDefinition.Slices for parameter.parameter:offset.binding.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:offset.binding.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:offset.binding.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:offset.binding.strength 1..1 code required | extensible | preferred | example
Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding.
OperationDefinition.Slices for parameter.parameter:offset.binding.valueSet 1..1 canonical(ValueSet) Source of value set
OperationDefinition.Slices for parameter.parameter:offset.referencedFrom 0..* BackboneElement References to this parameter
OperationDefinition.Slices for parameter.parameter:offset.referencedFrom.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:offset.referencedFrom.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:offset.referencedFrom.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:offset.referencedFrom.source 1..1 string Referencing parameter
OperationDefinition.Slices for parameter.parameter:offset.referencedFrom.sourceId 0..1 string Element id of reference
OperationDefinition.Slices for parameter.parameter:offset.part C 0..* See parameter (OperationDefinition) Parts of a nested Parameter
OperationDefinition.Slices for parameter.parameter:count This element must be supported. C 0..1 BackboneElement Parameters for the operation/query
Constraints: opd-1, opd-2, opd-3
OperationDefinition.Slices for parameter.parameter:count.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:count.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:count.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:count.name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: count (no extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
Required Pattern: in (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.min 1..1 integer Minimum Cardinality
Required Pattern: 0 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: 1 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.documentation 0..1 string Description of meaning/use
OperationDefinition.Slices for parameter.parameter:count.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.
Required Pattern: integer (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets
OperationDefinition.Slices for parameter.parameter:count.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.
OperationDefinition.Slices for parameter.parameter:count.binding 0..1 BackboneElement ValueSet details if this is coded
OperationDefinition.Slices for parameter.parameter:count.binding.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:count.binding.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:count.binding.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:count.binding.strength 1..1 code required | extensible | preferred | example
Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding.
OperationDefinition.Slices for parameter.parameter:count.binding.valueSet 1..1 canonical(ValueSet) Source of value set
OperationDefinition.Slices for parameter.parameter:count.referencedFrom 0..* BackboneElement References to this parameter
OperationDefinition.Slices for parameter.parameter:count.referencedFrom.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:count.referencedFrom.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:count.referencedFrom.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:count.referencedFrom.source 1..1 string Referencing parameter
OperationDefinition.Slices for parameter.parameter:count.referencedFrom.sourceId 0..1 string Element id of reference
OperationDefinition.Slices for parameter.parameter:count.part C 0..* See parameter (OperationDefinition) Parts of a nested Parameter
OperationDefinition.overload 0..* BackboneElement Define overloaded variants for when generating code
OperationDefinition.overload.id 0..1 string Unique id for inter-element referencing
OperationDefinition.overload.extension 0..* Extension Additional content defined by implementations
OperationDefinition.overload.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.overload.parameterName 0..* string Name of parameter to include in overload
OperationDefinition.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.0.1 FHIR Std.
OperationDefinition.​status Base required PublicationStatus 📍4.0.1 FHIR Std.
OperationDefinition.​kind Base required OperationKind 📍4.0.1 FHIR Std.
OperationDefinition.​jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
OperationDefinition.​resource Base required ResourceType 📍4.0.1 FHIR Std.
OperationDefinition.​parameter.use Base required OperationParameterUse 📍4.0.1 FHIR Std.
OperationDefinition.​parameter.type Base required FHIRAllTypes 📍4.0.1 FHIR Std.
OperationDefinition.​parameter.searchType Base required SearchParamType 📍4.0.1 FHIR Std.
OperationDefinition.​parameter.binding.strength Base required BindingStrength 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:offset.use Base required OperationParameterUse 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:offset.type Base required FHIRAllTypes 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:offset.searchType Base required SearchParamType 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:offset.binding.​strength Base required BindingStrength 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:count.use Base required OperationParameterUse 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:count.type Base required FHIRAllTypes 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:count.searchType Base required SearchParamType 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:count.binding.​strength Base required BindingStrength 📍4.0.1 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 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(canonical) = '#').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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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.matches('[A-Z]([A-Za-z0-9_]){0,254}')
opd-1 error OperationDefinition.parameter, OperationDefinition.parameter:offset, OperationDefinition.parameter:count Either a type must be provided, or parts type.exists() or part.exists()
opd-2 error OperationDefinition.parameter, OperationDefinition.parameter:offset, OperationDefinition.parameter:count A search type can only be specified for parameters of type string searchType.exists() implies type = 'string'
opd-3 error OperationDefinition.parameter, OperationDefinition.parameter:offset, OperationDefinition.parameter:count A targetProfile can only be specified for parameters of type Reference or Canonical targetProfile.exists() implies (type = 'Reference' or type = 'canonical')

This structure is derived from OperationDefinition

Summary

Must-Support: 2 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of OperationDefinition.parameter

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
OperationDefinition C 0..* OperationDefinition Definition of an operation or a named query
Constraints: opd-0
OperationDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
OperationDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
OperationDefinition.name This element is included in summaries. C 1..1 string Name for this operation definition (computer friendly)
OperationDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
OperationDefinition.kind This element is included in summaries. 1..1 code operation | query
Binding: OperationKind (required): Whether an operation is a normal operation or a query.
OperationDefinition.code This element is included in summaries. 1..1 code Name used to invoke the operation
OperationDefinition.system This element is included in summaries. 1..1 boolean Invoke at the system level?
OperationDefinition.type This element is included in summaries. 1..1 boolean Invoke at the type level?
OperationDefinition.instance This element is included in summaries. 1..1 boolean Invoke on an instance?
OperationDefinition.Slices for parameter C 0..* BackboneElement Parameters for the operation/query
Slice: Unordered, Open by value:name
Constraints: opd-1, opd-2, opd-3
OperationDefinition.Slices for parameter.parameter:All Slices Content/Rules for all slices
OperationDefinition.Slices for parameter.parameter:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:All Slices.name 1..1 code Name in Parameters.parameter.name or in URL
OperationDefinition.Slices for parameter.parameter:All Slices.use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
OperationDefinition.Slices for parameter.parameter:All Slices.min 1..1 integer Minimum Cardinality
OperationDefinition.Slices for parameter.parameter:All Slices.max 1..1 string Maximum Cardinality (a number or *)
OperationDefinition.Slices for parameter.parameter:offset This element must be supported. C 0..1 BackboneElement Parameters for the operation/query
Constraints: opd-1, opd-2, opd-3
OperationDefinition.Slices for parameter.parameter:offset.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:offset.name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: offset (no extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
Required Pattern: in (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.min 1..1 integer Minimum Cardinality
Required Pattern: 0 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: 1 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.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.
Required Pattern: integer (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count This element must be supported. C 0..1 BackboneElement Parameters for the operation/query
Constraints: opd-1, opd-2, opd-3
OperationDefinition.Slices for parameter.parameter:count.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:count.name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: count (no extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
Required Pattern: in (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.min 1..1 integer Minimum Cardinality
Required Pattern: 0 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: 1 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.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.
Required Pattern: integer (extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
OperationDefinition.​status Base required PublicationStatus 📍4.0.1 FHIR Std.
OperationDefinition.​kind Base required OperationKind 📍4.0.1 FHIR Std.
OperationDefinition.​parameter.use Base required OperationParameterUse 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:offset.use Base required OperationParameterUse 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:offset.type Base required FHIRAllTypes 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:count.use Base required OperationParameterUse 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:count.type Base required FHIRAllTypes 📍4.0.1 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 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(canonical) = '#').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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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.matches('[A-Z]([A-Za-z0-9_]){0,254}')
opd-1 error OperationDefinition.parameter, OperationDefinition.parameter:offset, OperationDefinition.parameter:count Either a type must be provided, or parts type.exists() or part.exists()
opd-2 error OperationDefinition.parameter, OperationDefinition.parameter:offset, OperationDefinition.parameter:count A search type can only be specified for parameters of type string searchType.exists() implies type = 'string'
opd-3 error OperationDefinition.parameter, OperationDefinition.parameter:offset, OperationDefinition.parameter:count A targetProfile can only be specified for parameters of type Reference or Canonical targetProfile.exists() implies (type = 'Reference' or type = 'canonical')

Differential View

This structure is derived from OperationDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
OperationDefinition 0..* OperationDefinition Definition of an operation or a named query
OperationDefinition.Slices for parameter 0..* BackboneElement Parameters for the operation/query
Slice: Unordered, Open by value:name
OperationDefinition.Slices for parameter.parameter:offset This element must be supported. 0..1 BackboneElement Parameters for the operation/query
OperationDefinition.Slices for parameter.parameter:offset.name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: offset (no extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.use 1..1 code in | out
Required Pattern: in (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.min 1..1 integer Minimum Cardinality
Required Pattern: 0 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: 1 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.type 0..1 code What type this parameter has
Required Pattern: integer (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count This element must be supported. 0..1 BackboneElement Parameters for the operation/query
OperationDefinition.Slices for parameter.parameter:count.name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: count (no extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.use 1..1 code in | out
Required Pattern: in (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.min 1..1 integer Minimum Cardinality
Required Pattern: 0 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: 1 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.type 0..1 code What type this parameter has
Required Pattern: integer (extensions allowed)

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
OperationDefinition C 0..* OperationDefinition Definition of an operation or a named query
Constraints: opd-0
OperationDefinition.id This element is included in summaries. 0..1 id Logical id of this artifact
OperationDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
OperationDefinition.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
OperationDefinition.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
OperationDefinition.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
OperationDefinition.contained 0..* Resource Contained, inline Resources
OperationDefinition.extension 0..* Extension Additional content defined by implementations
OperationDefinition.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
OperationDefinition.url This element is included in summaries. 0..1 uri Canonical identifier for this operation definition, represented as a URI (globally unique)
OperationDefinition.version This element is included in summaries. 0..1 string Business version of the operation definition
OperationDefinition.name This element is included in summaries. C 1..1 string Name for this operation definition (computer friendly)
OperationDefinition.title This element is included in summaries. 0..1 string Name for this operation definition (human friendly)
OperationDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
OperationDefinition.kind This element is included in summaries. 1..1 code operation | query
Binding: OperationKind (required): Whether an operation is a normal operation or a query.
OperationDefinition.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
OperationDefinition.date This element is included in summaries. 0..1 dateTime Date last changed
OperationDefinition.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
OperationDefinition.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
OperationDefinition.description 0..1 markdown Natural language description of the operation definition
OperationDefinition.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
OperationDefinition.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for operation definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
OperationDefinition.purpose 0..1 markdown Why this operation definition is defined
OperationDefinition.affectsState This element is included in summaries. 0..1 boolean Whether content is changed by the operation
OperationDefinition.code This element is included in summaries. 1..1 code Name used to invoke the operation
OperationDefinition.comment 0..1 markdown Additional information about use
OperationDefinition.base This element is included in summaries. 0..1 canonical(OperationDefinition) Marks this as a profile of the base
OperationDefinition.resource This element is included in summaries. 0..* code Types this operation applies to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
OperationDefinition.system This element is included in summaries. 1..1 boolean Invoke at the system level?
OperationDefinition.type This element is included in summaries. 1..1 boolean Invoke at the type level?
OperationDefinition.instance This element is included in summaries. 1..1 boolean Invoke on an instance?
OperationDefinition.inputProfile 0..1 canonical(StructureDefinition) Validation information for in parameters
OperationDefinition.outputProfile 0..1 canonical(StructureDefinition) Validation information for out parameters
OperationDefinition.Slices for parameter C 0..* BackboneElement Parameters for the operation/query
Slice: Unordered, Open by value:name
Constraints: opd-1, opd-2, opd-3
OperationDefinition.Slices for parameter.parameter:All Slices Content/Rules for all slices
OperationDefinition.Slices for parameter.parameter:All Slices.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:All Slices.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:All Slices.name 1..1 code Name in Parameters.parameter.name or in URL
OperationDefinition.Slices for parameter.parameter:All Slices.use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
OperationDefinition.Slices for parameter.parameter:All Slices.min 1..1 integer Minimum Cardinality
OperationDefinition.Slices for parameter.parameter:All Slices.max 1..1 string Maximum Cardinality (a number or *)
OperationDefinition.Slices for parameter.parameter:All Slices.documentation 0..1 string Description of meaning/use
OperationDefinition.Slices for parameter.parameter:All Slices.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.
OperationDefinition.Slices for parameter.parameter:All Slices.targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets
OperationDefinition.Slices for parameter.parameter:All Slices.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.
OperationDefinition.Slices for parameter.parameter:All Slices.binding 0..1 BackboneElement ValueSet details if this is coded
OperationDefinition.Slices for parameter.parameter:All Slices.binding.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:All Slices.binding.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:All Slices.binding.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:All Slices.binding.strength 1..1 code required | extensible | preferred | example
Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding.
OperationDefinition.Slices for parameter.parameter:All Slices.binding.valueSet 1..1 canonical(ValueSet) Source of value set
OperationDefinition.Slices for parameter.parameter:All Slices.referencedFrom 0..* BackboneElement References to this parameter
OperationDefinition.Slices for parameter.parameter:All Slices.referencedFrom.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:All Slices.referencedFrom.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:All Slices.referencedFrom.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:All Slices.referencedFrom.source 1..1 string Referencing parameter
OperationDefinition.Slices for parameter.parameter:All Slices.referencedFrom.sourceId 0..1 string Element id of reference
OperationDefinition.Slices for parameter.parameter:All Slices.part C 0..* See parameter (OperationDefinition) Parts of a nested Parameter
OperationDefinition.Slices for parameter.parameter:offset This element must be supported. C 0..1 BackboneElement Parameters for the operation/query
Constraints: opd-1, opd-2, opd-3
OperationDefinition.Slices for parameter.parameter:offset.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:offset.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:offset.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:offset.name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: offset (no extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
Required Pattern: in (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.min 1..1 integer Minimum Cardinality
Required Pattern: 0 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: 1 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.documentation 0..1 string Description of meaning/use
OperationDefinition.Slices for parameter.parameter:offset.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.
Required Pattern: integer (extensions allowed)
OperationDefinition.Slices for parameter.parameter:offset.targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets
OperationDefinition.Slices for parameter.parameter:offset.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.
OperationDefinition.Slices for parameter.parameter:offset.binding 0..1 BackboneElement ValueSet details if this is coded
OperationDefinition.Slices for parameter.parameter:offset.binding.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:offset.binding.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:offset.binding.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:offset.binding.strength 1..1 code required | extensible | preferred | example
Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding.
OperationDefinition.Slices for parameter.parameter:offset.binding.valueSet 1..1 canonical(ValueSet) Source of value set
OperationDefinition.Slices for parameter.parameter:offset.referencedFrom 0..* BackboneElement References to this parameter
OperationDefinition.Slices for parameter.parameter:offset.referencedFrom.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:offset.referencedFrom.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:offset.referencedFrom.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:offset.referencedFrom.source 1..1 string Referencing parameter
OperationDefinition.Slices for parameter.parameter:offset.referencedFrom.sourceId 0..1 string Element id of reference
OperationDefinition.Slices for parameter.parameter:offset.part C 0..* See parameter (OperationDefinition) Parts of a nested Parameter
OperationDefinition.Slices for parameter.parameter:count This element must be supported. C 0..1 BackboneElement Parameters for the operation/query
Constraints: opd-1, opd-2, opd-3
OperationDefinition.Slices for parameter.parameter:count.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:count.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:count.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:count.name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: count (no extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
Required Pattern: in (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.min 1..1 integer Minimum Cardinality
Required Pattern: 0 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.max 1..1 string Maximum Cardinality (a number or *)
Required Pattern: 1 (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.documentation 0..1 string Description of meaning/use
OperationDefinition.Slices for parameter.parameter:count.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.
Required Pattern: integer (extensions allowed)
OperationDefinition.Slices for parameter.parameter:count.targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets
OperationDefinition.Slices for parameter.parameter:count.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.
OperationDefinition.Slices for parameter.parameter:count.binding 0..1 BackboneElement ValueSet details if this is coded
OperationDefinition.Slices for parameter.parameter:count.binding.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:count.binding.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:count.binding.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:count.binding.strength 1..1 code required | extensible | preferred | example
Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding.
OperationDefinition.Slices for parameter.parameter:count.binding.valueSet 1..1 canonical(ValueSet) Source of value set
OperationDefinition.Slices for parameter.parameter:count.referencedFrom 0..* BackboneElement References to this parameter
OperationDefinition.Slices for parameter.parameter:count.referencedFrom.id 0..1 string Unique id for inter-element referencing
OperationDefinition.Slices for parameter.parameter:count.referencedFrom.extension 0..* Extension Additional content defined by implementations
OperationDefinition.Slices for parameter.parameter:count.referencedFrom.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.Slices for parameter.parameter:count.referencedFrom.source 1..1 string Referencing parameter
OperationDefinition.Slices for parameter.parameter:count.referencedFrom.sourceId 0..1 string Element id of reference
OperationDefinition.Slices for parameter.parameter:count.part C 0..* See parameter (OperationDefinition) Parts of a nested Parameter
OperationDefinition.overload 0..* BackboneElement Define overloaded variants for when generating code
OperationDefinition.overload.id 0..1 string Unique id for inter-element referencing
OperationDefinition.overload.extension 0..* Extension Additional content defined by implementations
OperationDefinition.overload.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
OperationDefinition.overload.parameterName 0..* string Name of parameter to include in overload
OperationDefinition.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.0.1 FHIR Std.
OperationDefinition.​status Base required PublicationStatus 📍4.0.1 FHIR Std.
OperationDefinition.​kind Base required OperationKind 📍4.0.1 FHIR Std.
OperationDefinition.​jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
OperationDefinition.​resource Base required ResourceType 📍4.0.1 FHIR Std.
OperationDefinition.​parameter.use Base required OperationParameterUse 📍4.0.1 FHIR Std.
OperationDefinition.​parameter.type Base required FHIRAllTypes 📍4.0.1 FHIR Std.
OperationDefinition.​parameter.searchType Base required SearchParamType 📍4.0.1 FHIR Std.
OperationDefinition.​parameter.binding.strength Base required BindingStrength 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:offset.use Base required OperationParameterUse 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:offset.type Base required FHIRAllTypes 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:offset.searchType Base required SearchParamType 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:offset.binding.​strength Base required BindingStrength 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:count.use Base required OperationParameterUse 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:count.type Base required FHIRAllTypes 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:count.searchType Base required SearchParamType 📍4.0.1 FHIR Std.
OperationDefinition.​parameter:count.binding.​strength Base required BindingStrength 📍4.0.1 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 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(canonical) = '#').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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions 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.matches('[A-Z]([A-Za-z0-9_]){0,254}')
opd-1 error OperationDefinition.parameter, OperationDefinition.parameter:offset, OperationDefinition.parameter:count Either a type must be provided, or parts type.exists() or part.exists()
opd-2 error OperationDefinition.parameter, OperationDefinition.parameter:offset, OperationDefinition.parameter:count A search type can only be specified for parameters of type string searchType.exists() implies type = 'string'
opd-3 error OperationDefinition.parameter, OperationDefinition.parameter:offset, OperationDefinition.parameter:count A targetProfile can only be specified for parameters of type Reference or Canonical targetProfile.exists() implies (type = 'Reference' or type = 'canonical')

This structure is derived from OperationDefinition

Summary

Must-Support: 2 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of OperationDefinition.parameter

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron