This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: CRMI Publishable OperationDefinition

Supports declaration of the OperationDefinition metadata required by HL7 and other organizations that share and publish operation definitions with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

Usage:

• Examples for this Resource Profile: PublishableOperationDefinitionExample

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from OperationDefinition

Name	Flags	Card.	Type	Description & Constraints
OperationDefinition		1..1	OperationDefinition	Definition of an operation or a named query
Slices for extension				Content/Rules for all slices
identifier	S	0..*	Identifier	Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
usage	S	0..1	markdown	Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
copyright	S	0..1	markdown	Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
approvalDate	S	0..1	date	When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
lastReviewDate	S	0..1	date	When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
effectivePeriod	S	0..1	Period	When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
date	S	1..1	dateTime	Date last changed
contact	S	0..*	ContactDetail	Contact details for the publisher
useContext	S	0..*	UsageContext	The context that the content is intended to support
jurisdiction	S	0..*	CodeableConcept	Intended jurisdiction for operation definition (if applicable)
purpose	S	0..1	markdown	Why this operation definition is defined
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
OperationDefinition	C	1..1	OperationDefinition	Definition of an operation or a named query opd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
identifier	S	0..*	Identifier	Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
usage	S	0..1	markdown	Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
copyright	S	0..1	markdown	Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
approvalDate	S	0..1	date	When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
lastReviewDate	S	0..1	date	When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
effectivePeriod	S	0..1	Period	When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
name	ΣC	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 an artifact.
kind	Σ	1..1	code	operation | query Binding: OperationKind (required): Whether an operation is a normal operation or a query.
date	SΣ	1..1	dateTime	Date last changed
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	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	S	0..1	markdown	Why this operation definition is defined
code	Σ	1..1	code	Name used to invoke the operation
system	Σ	1..1	boolean	Invoke at the system level?
type	Σ	1..1	boolean	Invoke at the type level?
instance	Σ	1..1	boolean	Invoke on an instance?
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
OperationDefinition.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
OperationDefinition.kind	required	OperationKind http://hl7.org/fhir/ValueSet/operation-kind|4.0.1 from the FHIR Standard
OperationDefinition.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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}')

Name	Flags	Card.	Type	Description & Constraints
OperationDefinition	C	1..1	OperationDefinition	Definition of an operation or a named query opd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier	S	0..*	Identifier	Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
usage	S	0..1	markdown	Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
copyright	S	0..1	markdown	Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
approvalDate	S	0..1	date	When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
lastReviewDate	S	0..1	date	When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
effectivePeriod	S	0..1	Period	When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	0..1	uri	Canonical identifier for this operation definition, represented as a URI (globally unique)
version	Σ	0..1	string	Business version of the operation definition
name	ΣC	1..1	string	Name for this operation definition (computer friendly)
title	Σ	0..1	string	Name for this operation definition (human friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
kind	Σ	1..1	code	operation | query Binding: OperationKind (required): Whether an operation is a normal operation or a query.
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	SΣ	1..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher (organization or individual)
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the operation definition
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	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	S	0..1	markdown	Why this operation definition is defined
affectsState	Σ	0..1	boolean	Whether content is changed by the operation
code	Σ	1..1	code	Name used to invoke the operation
comment		0..1	markdown	Additional information about use
base	Σ	0..1	canonical(OperationDefinition)	Marks this as a profile of the base
resource	Σ	0..*	code	Types this operation applies to Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
system	Σ	1..1	boolean	Invoke at the system level?
type	Σ	1..1	boolean	Invoke at the type level?
instance	Σ	1..1	boolean	Invoke on an instance?
inputProfile		0..1	canonical(StructureDefinition)	Validation information for in parameters
outputProfile		0..1	canonical(StructureDefinition)	Validation information for out parameters
parameter	C	0..*	BackboneElement	Parameters for the operation/query opd-1: Either a type must be provided, or parts opd-2: A search type can only be specified for parameters of type string opd-3: A targetProfile can only be specified for parameters of type Reference or Canonical
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		1..1	code	Name in Parameters.parameter.name or in URL
use		1..1	code	in | out Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
min		1..1	integer	Minimum Cardinality
max		1..1	string	Maximum Cardinality (a number or *)
documentation		0..1	string	Description of meaning/use
type	C	0..1	code	What type this parameter has Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
targetProfile		0..*	canonical(StructureDefinition)	If type is Reference | canonical, allowed targets
searchType	C	0..1	code	number | date | string | token | reference | composite | quantity | uri | special Binding: SearchParamType (required): Data types allowed to be used for search parameters.
binding		0..1	BackboneElement	ValueSet details if this is coded
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
strength		1..1	code	required | extensible | preferred | example Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding.
valueSet		1..1	canonical(ValueSet)	Source of value set
referencedFrom		0..*	BackboneElement	References to this parameter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
source		1..1	string	Referencing parameter
sourceId		0..1	string	Element id of reference
part	C	0..*	See parameter (OperationDefinition)	Parts of a nested Parameter
overload		0..*	BackboneElement	Define overloaded variants for when generating code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
parameterName		0..*	string	Name of parameter to include in overload
comment		0..1	string	Comments to go on overload
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
OperationDefinition.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
OperationDefinition.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
OperationDefinition.kind	required	OperationKind http://hl7.org/fhir/ValueSet/operation-kind|4.0.1 from the FHIR Standard
OperationDefinition.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
OperationDefinition.resource	required	ResourceType http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard
OperationDefinition.parameter.use	required	OperationParameterUse http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1 from the FHIR Standard
OperationDefinition.parameter.type	required	FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 from the FHIR Standard
OperationDefinition.parameter.searchType	required	SearchParamType http://hl7.org/fhir/ValueSet/search-param-type|4.0.1 from the FHIR Standard
OperationDefinition.parameter.binding.strength	required	BindingStrength http://hl7.org/fhir/ValueSet/binding-strength|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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	Either a type must be provided, or parts : type.exists() or part.exists()
opd-2	error	OperationDefinition.parameter	A search type can only be specified for parameters of type string : searchType.exists() implies type = 'string'
opd-3	error	OperationDefinition.parameter	A targetProfile can only be specified for parameters of type Reference or Canonical : targetProfile.exists() implies (type = 'Reference' or type = 'canonical')

This structure is derived from OperationDefinition

Summary

Mandatory: 1 element
Must-Support: 18 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/artifact-identifier
• http://hl7.org/fhir/StructureDefinition/artifact-usage
• http://hl7.org/fhir/StructureDefinition/artifact-copyright
• http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
• http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
• http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
• http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
• http://hl7.org/fhir/StructureDefinition/artifact-topic
• http://hl7.org/fhir/StructureDefinition/artifact-author
• http://hl7.org/fhir/StructureDefinition/artifact-editor
• http://hl7.org/fhir/StructureDefinition/artifact-reviewer
• http://hl7.org/fhir/StructureDefinition/artifact-endorser
• http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact

Maturity: 1

Differential View

This structure is derived from OperationDefinition

Name	Flags	Card.	Type	Description & Constraints
OperationDefinition		1..1	OperationDefinition	Definition of an operation or a named query
Slices for extension				Content/Rules for all slices
identifier	S	0..*	Identifier	Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
usage	S	0..1	markdown	Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
copyright	S	0..1	markdown	Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
approvalDate	S	0..1	date	When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
lastReviewDate	S	0..1	date	When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
effectivePeriod	S	0..1	Period	When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
date	S	1..1	dateTime	Date last changed
contact	S	0..*	ContactDetail	Contact details for the publisher
useContext	S	0..*	UsageContext	The context that the content is intended to support
jurisdiction	S	0..*	CodeableConcept	Intended jurisdiction for operation definition (if applicable)
purpose	S	0..1	markdown	Why this operation definition is defined
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
OperationDefinition	C	1..1	OperationDefinition	Definition of an operation or a named query opd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
identifier	S	0..*	Identifier	Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
usage	S	0..1	markdown	Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
copyright	S	0..1	markdown	Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
approvalDate	S	0..1	date	When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
lastReviewDate	S	0..1	date	When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
effectivePeriod	S	0..1	Period	When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
name	ΣC	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 an artifact.
kind	Σ	1..1	code	operation | query Binding: OperationKind (required): Whether an operation is a normal operation or a query.
date	SΣ	1..1	dateTime	Date last changed
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	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	S	0..1	markdown	Why this operation definition is defined
code	Σ	1..1	code	Name used to invoke the operation
system	Σ	1..1	boolean	Invoke at the system level?
type	Σ	1..1	boolean	Invoke at the type level?
instance	Σ	1..1	boolean	Invoke on an instance?
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
OperationDefinition.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
OperationDefinition.kind	required	OperationKind http://hl7.org/fhir/ValueSet/operation-kind|4.0.1 from the FHIR Standard
OperationDefinition.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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}')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
OperationDefinition	C	1..1	OperationDefinition	Definition of an operation or a named query opd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier	S	0..*	Identifier	Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
usage	S	0..1	markdown	Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
copyright	S	0..1	markdown	Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
copyrightLabel	S	0..1	string	Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
approvalDate	S	0..1	date	When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
lastReviewDate	S	0..1	date	When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
effectivePeriod	S	0..1	Period	When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
topic	S	0..*	CodeableConcept	E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact
author	S	0..*	ContactDetail	Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author
editor	S	0..*	ContactDetail	Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
reviewer	S	0..*	ContactDetail	Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
endorser	S	0..*	ContactDetail	Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
relatedArtifact	S	0..*	RelatedArtifact	Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	Σ	0..1	uri	Canonical identifier for this operation definition, represented as a URI (globally unique)
version	Σ	0..1	string	Business version of the operation definition
name	ΣC	1..1	string	Name for this operation definition (computer friendly)
title	Σ	0..1	string	Name for this operation definition (human friendly)
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
kind	Σ	1..1	code	operation | query Binding: OperationKind (required): Whether an operation is a normal operation or a query.
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	SΣ	1..1	dateTime	Date last changed
publisher	Σ	0..1	string	Name of the publisher (organization or individual)
contact	SΣ	0..*	ContactDetail	Contact details for the publisher
description		0..1	markdown	Natural language description of the operation definition
useContext	SΣ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	SΣ	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	S	0..1	markdown	Why this operation definition is defined
affectsState	Σ	0..1	boolean	Whether content is changed by the operation
code	Σ	1..1	code	Name used to invoke the operation
comment		0..1	markdown	Additional information about use
base	Σ	0..1	canonical(OperationDefinition)	Marks this as a profile of the base
resource	Σ	0..*	code	Types this operation applies to Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
system	Σ	1..1	boolean	Invoke at the system level?
type	Σ	1..1	boolean	Invoke at the type level?
instance	Σ	1..1	boolean	Invoke on an instance?
inputProfile		0..1	canonical(StructureDefinition)	Validation information for in parameters
outputProfile		0..1	canonical(StructureDefinition)	Validation information for out parameters
parameter	C	0..*	BackboneElement	Parameters for the operation/query opd-1: Either a type must be provided, or parts opd-2: A search type can only be specified for parameters of type string opd-3: A targetProfile can only be specified for parameters of type Reference or Canonical
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		1..1	code	Name in Parameters.parameter.name or in URL
use		1..1	code	in | out Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
min		1..1	integer	Minimum Cardinality
max		1..1	string	Maximum Cardinality (a number or *)
documentation		0..1	string	Description of meaning/use
type	C	0..1	code	What type this parameter has Binding: FHIRAllTypes (required): A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
targetProfile		0..*	canonical(StructureDefinition)	If type is Reference | canonical, allowed targets
searchType	C	0..1	code	number | date | string | token | reference | composite | quantity | uri | special Binding: SearchParamType (required): Data types allowed to be used for search parameters.
binding		0..1	BackboneElement	ValueSet details if this is coded
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
strength		1..1	code	required | extensible | preferred | example Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding.
valueSet		1..1	canonical(ValueSet)	Source of value set
referencedFrom		0..*	BackboneElement	References to this parameter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
source		1..1	string	Referencing parameter
sourceId		0..1	string	Element id of reference
part	C	0..*	See parameter (OperationDefinition)	Parts of a nested Parameter
overload		0..*	BackboneElement	Define overloaded variants for when generating code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
parameterName		0..*	string	Name of parameter to include in overload
comment		0..1	string	Comments to go on overload
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
OperationDefinition.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
OperationDefinition.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
OperationDefinition.kind	required	OperationKind http://hl7.org/fhir/ValueSet/operation-kind|4.0.1 from the FHIR Standard
OperationDefinition.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
OperationDefinition.resource	required	ResourceType http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard
OperationDefinition.parameter.use	required	OperationParameterUse http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1 from the FHIR Standard
OperationDefinition.parameter.type	required	FHIRAllTypes http://hl7.org/fhir/ValueSet/all-types|4.0.1 from the FHIR Standard
OperationDefinition.parameter.searchType	required	SearchParamType http://hl7.org/fhir/ValueSet/search-param-type|4.0.1 from the FHIR Standard
OperationDefinition.parameter.binding.strength	required	BindingStrength http://hl7.org/fhir/ValueSet/binding-strength|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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	Either a type must be provided, or parts : type.exists() or part.exists()
opd-2	error	OperationDefinition.parameter	A search type can only be specified for parameters of type string : searchType.exists() implies type = 'string'
opd-3	error	OperationDefinition.parameter	A targetProfile can only be specified for parameters of type Reference or Canonical : targetProfile.exists() implies (type = 'Reference' or type = 'canonical')

This structure is derived from OperationDefinition

Summary

Mandatory: 1 element
Must-Support: 18 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/artifact-identifier
• http://hl7.org/fhir/StructureDefinition/artifact-usage
• http://hl7.org/fhir/StructureDefinition/artifact-copyright
• http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
• http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
• http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
• http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
• http://hl7.org/fhir/StructureDefinition/artifact-topic
• http://hl7.org/fhir/StructureDefinition/artifact-author
• http://hl7.org/fhir/StructureDefinition/artifact-editor
• http://hl7.org/fhir/StructureDefinition/artifact-reviewer
• http://hl7.org/fhir/StructureDefinition/artifact-endorser
• http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact

Maturity: 1

Other representations of profile: CSV, Excel, Schematron