NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationDefinition NDomainResourceDefinition of an operation or a named query
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: A query operation cannot be defined at the instance level
+ Rule: A query operation requires input parameters to have a search type
+ Rule: Named queries always have a single output parameter named 'result' of type Bundle

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: CanonicalResource
... url ΣC0..1uriCanonical identifier for this operation definition, represented as an absolute URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier ΣTU0..*IdentifierAdditional identifier for the implementation guide (business identifier)

... version Σ0..1stringBusiness version of the operation definition
... versionAlgorithm[x] ΣTU0..1How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC1..1stringName for this operation definition (computer friendly)
... title ΣT0..1stringName for this operation definition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... kind ΣC1..1codeoperation | query
Binding: Operation Kind (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description T0..1markdownNatural language description of the operation definition
... useContext ΣTU0..*UsageContextThe context that the content is intended to support

... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for operation definition (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this operation definition is defined
... copyright TTU0..1markdownUse and/or publishing restrictions
... copyrightLabel TTU0..1stringCopyright holder and year(s)
... affectsState Σ0..1booleanWhether content is changed by the operation
... code Σ1..1codeRecommended name for operation in search url
... comment 0..1markdownAdditional information about use
... base Σ0..1canonical(OperationDefinition)Marks this as a profile of the base
... resource Σ0..*codeTypes this operation applies to
Binding: Version Independent Resource Types (All) (Required)
Additional BindingsPurpose
All Resource TypesUI Binding


... system Σ1..1booleanInvoke at the system level?
... type Σ1..1booleanInvoke at the type level?
... instance ΣC1..1booleanInvoke on an instance?
... inputProfile 0..1canonical(StructureDefinition)Validation information for in parameters
... outputProfile 0..1canonical(StructureDefinition)Validation information for out parameters
... parameter C0..*BackboneElementParameters for the operation/query
+ Rule: Either a type must be provided, or parts
+ Rule: A search type can only be specified for parameters of type string
+ Rule: A targetProfile can only be specified for parameters of type Reference, Canonical, or a Resource
+ Rule: SearchParamType can only be specified on in parameters

.... name C1..1codeName in Parameters.parameter.name or in URL
.... use C1..1codein | out
Binding: Operation Parameter Use (Required)
.... scope TU0..*codeinstance | type | system
Binding: Operation Parameter Scope (Required)

.... min 1..1integerMinimum Cardinality
.... max 1..1stringMaximum Cardinality (a number or *)
.... documentation T0..1markdownDescription of meaning/use
.... type C0..1codeWhat type this parameter has
Binding: All FHIR Types (Required)
.... allowedType TU0..*codeAllowed sub-type this parameter can have (if type is abstract)
Binding: All FHIR Types (Required)

.... targetProfile C0..*canonical(StructureDefinition)If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types

.... searchType C0..1codenumber | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (Required)
.... binding 0..1BackboneElementValueSet details if this is coded
..... strength 1..1coderequired | extensible | preferred | example
Binding: BindingStrength (Required)
..... valueSet 1..1canonical(ValueSet)Source of value set
.... referencedFrom TU0..*BackboneElementReferences to this parameter

..... source 1..1stringReferencing parameter
..... sourceId 0..1stringElement id of reference
.... part C0..*see parameterParts of a nested Parameter

... overload 0..*BackboneElementDefine overloaded variants for when generating code

.... parameterName 0..*stringName of parameter to include in overload

.... comment 0..1stringComments to go on overload

doco Documentation for this format