Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU International flag

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

Resource Profile: Profile_R5_OperationDefinition_R3

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

This cross-version profile allows R5 OperationDefinition content to be represented via FHIR STU3 OperationDefinition resources.

Usages:

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 0..* OperationDefinition Definition of an operation or a named query
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-identifier]] R5: Additional identifier for the implementation guide (business identifier) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:title 0..1 string R5: Name for this operation definition (human friendly) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.title
.... extension:copyright 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyright]] R5: Use and/or publishing restrictions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:inputProfile 0..1 uri R5: Validation information for in parameters (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.inputProfile
.... extension:outputProfile 0..1 uri R5: Validation information for out parameters (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.outputProfile
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
... 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
... code Σ 1..1 code Name used to invoke the operation
... system Σ 1..1 boolean Invoke at the system level?
... type Σ 1..1 boolean Invole 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 📍3.0.2 FHIR Std.
OperationDefinition.​kind Base required OperationKind 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error OperationDefinition If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from OperationDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition 0..* OperationDefinition Definition of an operation or a named query
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-identifier]] R5: Additional identifier for the implementation guide (business identifier) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:title 0..1 string R5: Name for this operation definition (human friendly) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.title
.... extension:copyright 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyright]] R5: Use and/or publishing restrictions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:inputProfile 0..1 uri R5: Validation information for in parameters (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.inputProfile
.... extension:outputProfile 0..1 uri R5: Validation information for out parameters (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.outputProfile
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.contact
... base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..1 uri R5: base additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:scope 0..* code R5: instance | type | system (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.scope
Binding: R5OperationParameterScopeForR3 (0.1.0) (required)
..... extension:allowedType 0..* code R5: Allowed sub-type this parameter can have (if type is abstract) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.allowedType
Binding: R5FhirTypesForR3 (0.1.0) (required): A list of all the types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
..... extension:referencedFrom 0..* (Complex) R5: References to this parameter (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.referencedFrom
.... searchType
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:searchType 0..1 code R5: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.searchType
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
.... profile
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:targetProfile 0..* uri R5: If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.targetProfile

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition 0..* OperationDefinition Definition of an operation or a named query
... 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: Common Languages . (extensible): A human language.
Additional BindingsPurpose
All Languages 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-identifier]] R5: Additional identifier for the implementation guide (business identifier) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:title 0..1 string R5: Name for this operation definition (human friendly) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.title
.... extension:copyright 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyright]] R5: Use and/or publishing restrictions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:inputProfile 0..1 uri R5: Validation information for in parameters (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.inputProfile
.... extension:outputProfile 0..1 uri R5: Validation information for out parameters (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.outputProfile
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Logical URI to reference this operation definition (globally unique)
... version Σ 0..1 string Business version of the operation definition
... name Σ 1..1 string Name for this operation definition (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
... 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 this was last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.contact
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... description 0..1 markdown Natural language description of the operation definition
... useContext Σ 0..* UsageContext Context 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
... idempotent Σ 0..1 boolean Whether content is unchanged by the operation
... code Σ 1..1 code Name used to invoke the operation
... comment 0..1 string Additional information about use
... base Σ 0..1 Reference(OperationDefinition) Marks this as a profile of the base
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..1 uri R5: base additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.base
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... resource Σ 0..* code Types this operation applies to
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
... system Σ 1..1 boolean Invoke at the system level?
... type Σ 1..1 boolean Invole at the type level?
... instance Σ 1..1 boolean Invoke on an instance?
... parameter C 0..* BackboneElement Parameters for the operation/query
Constraints: opd-1, opd-2
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:scope 0..* code R5: instance | type | system (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.scope
Binding: R5OperationParameterScopeForR3 (0.1.0) (required)
..... extension:allowedType 0..* code R5: Allowed sub-type this parameter can have (if type is abstract) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.allowedType
Binding: R5FhirTypesForR3 (0.1.0) (required): A list of all the types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
..... extension:referencedFrom 0..* (Complex) R5: References to this parameter (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.referencedFrom
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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): Either an abstract type, a resource or a data type.
.... searchType C 0..1 code number | date | string | token | reference | composite | quantity | uri
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:searchType 0..1 code R5: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.searchType
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
..... value 0..1 code Primitive value for code
.... profile 0..1 Reference(StructureDefinition) Profile on the type
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:targetProfile 0..* uri R5: If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.targetProfile
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... binding 0..1 BackboneElement ValueSet details if this is coded
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... strength 1..1 code required | extensible | preferred | example
Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding.
..... valueSet[x] 1..1 Source of value set
...... valueSetUri uri
...... valueSetReference Reference(ValueSet)
.... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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 extensible Common Languages . 📍3.0.2 tx.fhir.org
OperationDefinition.​status Base required PublicationStatus 📍3.0.2 FHIR Std.
OperationDefinition.​kind Base required OperationKind 📍3.0.2 FHIR Std.
OperationDefinition.​jurisdiction Base extensible Jurisdiction ValueSet 📍3.0.2 FHIR Std.
OperationDefinition.​resource Base required ResourceType . 📍3.0.2 tx.fhir.org
OperationDefinition.​parameter.use Base required OperationParameterUse 📍3.0.2 FHIR Std.
OperationDefinition.​parameter.type Base required FHIRAllTypes 📍3.0.2 FHIR Std.
OperationDefinition.​parameter.searchType Base required SearchParamType 📍3.0.2 FHIR Std.
OperationDefinition.​parameter.binding.strength Base required BindingStrength 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error OperationDefinition If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
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 implies type = 'string'

This structure is derived from OperationDefinition

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition 0..* OperationDefinition Definition of an operation or a named query
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-identifier]] R5: Additional identifier for the implementation guide (business identifier) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:title 0..1 string R5: Name for this operation definition (human friendly) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.title
.... extension:copyright 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyright]] R5: Use and/or publishing restrictions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:inputProfile 0..1 uri R5: Validation information for in parameters (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.inputProfile
.... extension:outputProfile 0..1 uri R5: Validation information for out parameters (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.outputProfile
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
... 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
... code Σ 1..1 code Name used to invoke the operation
... system Σ 1..1 boolean Invoke at the system level?
... type Σ 1..1 boolean Invole 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 📍3.0.2 FHIR Std.
OperationDefinition.​kind Base required OperationKind 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error OperationDefinition If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from OperationDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition 0..* OperationDefinition Definition of an operation or a named query
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-identifier]] R5: Additional identifier for the implementation guide (business identifier) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:title 0..1 string R5: Name for this operation definition (human friendly) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.title
.... extension:copyright 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyright]] R5: Use and/or publishing restrictions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:inputProfile 0..1 uri R5: Validation information for in parameters (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.inputProfile
.... extension:outputProfile 0..1 uri R5: Validation information for out parameters (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.outputProfile
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.contact
... base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..1 uri R5: base additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:scope 0..* code R5: instance | type | system (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.scope
Binding: R5OperationParameterScopeForR3 (0.1.0) (required)
..... extension:allowedType 0..* code R5: Allowed sub-type this parameter can have (if type is abstract) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.allowedType
Binding: R5FhirTypesForR3 (0.1.0) (required): A list of all the types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
..... extension:referencedFrom 0..* (Complex) R5: References to this parameter (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.referencedFrom
.... searchType
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:searchType 0..1 code R5: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.searchType
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
.... profile
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:targetProfile 0..* uri R5: If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.targetProfile

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition 0..* OperationDefinition Definition of an operation or a named query
... 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: Common Languages . (extensible): A human language.
Additional BindingsPurpose
All Languages 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:identifier 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-identifier]] R5: Additional identifier for the implementation guide (business identifier) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:title 0..1 string R5: Name for this operation definition (human friendly) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.title
.... extension:copyright 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyright]] R5: Use and/or publishing restrictions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:inputProfile 0..1 uri R5: Validation information for in parameters (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.inputProfile
.... extension:outputProfile 0..1 uri R5: Validation information for out parameters (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.outputProfile
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Logical URI to reference this operation definition (globally unique)
... version Σ 0..1 string Business version of the operation definition
... name Σ 1..1 string Name for this operation definition (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
... 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 this was last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.contact
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... description 0..1 markdown Natural language description of the operation definition
... useContext Σ 0..* UsageContext Context 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
... idempotent Σ 0..1 boolean Whether content is unchanged by the operation
... code Σ 1..1 code Name used to invoke the operation
... comment 0..1 string Additional information about use
... base Σ 0..1 Reference(OperationDefinition) Marks this as a profile of the base
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..1 uri R5: base additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.base
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... resource Σ 0..* code Types this operation applies to
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
... system Σ 1..1 boolean Invoke at the system level?
... type Σ 1..1 boolean Invole at the type level?
... instance Σ 1..1 boolean Invoke on an instance?
... parameter C 0..* BackboneElement Parameters for the operation/query
Constraints: opd-1, opd-2
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:scope 0..* code R5: instance | type | system (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.scope
Binding: R5OperationParameterScopeForR3 (0.1.0) (required)
..... extension:allowedType 0..* code R5: Allowed sub-type this parameter can have (if type is abstract) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.allowedType
Binding: R5FhirTypesForR3 (0.1.0) (required): A list of all the types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
..... extension:referencedFrom 0..* (Complex) R5: References to this parameter (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.referencedFrom
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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): Either an abstract type, a resource or a data type.
.... searchType C 0..1 code number | date | string | token | reference | composite | quantity | uri
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:searchType 0..1 code R5: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.searchType
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
..... value 0..1 code Primitive value for code
.... profile 0..1 Reference(StructureDefinition) Profile on the type
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:targetProfile 0..* uri R5: If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-OperationDefinition.parameter.targetProfile
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... binding 0..1 BackboneElement ValueSet details if this is coded
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... strength 1..1 code required | extensible | preferred | example
Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding.
..... valueSet[x] 1..1 Source of value set
...... valueSetUri uri
...... valueSetReference Reference(ValueSet)
.... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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 extensible Common Languages . 📍3.0.2 tx.fhir.org
OperationDefinition.​status Base required PublicationStatus 📍3.0.2 FHIR Std.
OperationDefinition.​kind Base required OperationKind 📍3.0.2 FHIR Std.
OperationDefinition.​jurisdiction Base extensible Jurisdiction ValueSet 📍3.0.2 FHIR Std.
OperationDefinition.​resource Base required ResourceType . 📍3.0.2 tx.fhir.org
OperationDefinition.​parameter.use Base required OperationParameterUse 📍3.0.2 FHIR Std.
OperationDefinition.​parameter.type Base required FHIRAllTypes 📍3.0.2 FHIR Std.
OperationDefinition.​parameter.searchType Base required SearchParamType 📍3.0.2 FHIR Std.
OperationDefinition.​parameter.binding.strength Base required BindingStrength 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error OperationDefinition If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
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 implies type = 'string'

This structure is derived from OperationDefinition

 

Other representations of profile: CSV, Excel, Schematron