NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationDefinition INDomainResourceDefinition 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
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriCanonical identifier for this operation definition, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the operation definition
... name ΣI1..1stringName for this operation definition (computer friendly)
... title Σ0..1stringName for this operation definition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... kind Σ1..1codeoperation | query
OperationKind (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the operation definition
... useContext ΣTU0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for operation definition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this operation definition is defined
... affectsState Σ0..1booleanWhether content is changed by the operation
... code Σ1..1codeName used to invoke the operation
... 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
ResourceType (Required)
... system Σ1..1booleanInvoke at the system level?
... type Σ1..1booleanInvoke at the type level?
... instance Σ1..1booleanInvoke on an instance?
... inputProfile 0..1canonical(StructureDefinition)Validation information for in parameters
... outputProfile 0..1canonical(StructureDefinition)Validation information for out parameters
... parameter I0..*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 or Canonical
.... name 1..1codeName in Parameters.parameter.name or in URL
.... use 1..1codein | out
OperationParameterUse (Required)
.... min 1..1integerMinimum Cardinality
.... max 1..1stringMaximum Cardinality (a number or *)
.... documentation 0..1stringDescription of meaning/use
.... type I0..1codeWhat type this parameter has
FHIRAllTypes (Required)
.... targetProfile 0..*canonical(StructureDefinition)If type is Reference | canonical, allowed targets
.... searchType I0..1codenumber | date | string | token | reference | composite | quantity | uri | special
SearchParamType (Required)
.... binding 0..1BackboneElementValueSet details if this is coded
..... strength 1..1coderequired | extensible | preferred | example
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 I0..*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