Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/1.0/StructureDefinition/profile-OperationDefinition | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R2_OperationDefinition_R4 | ||
This cross-version profile allows DSTU2 OperationDefinition content to be represented via FHIR R4 OperationDefinition resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  OperationDefinition |
C | 0..* | OperationDefinition(4.0.1) | Definition of an operation or a named query Constraints: opd-0 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| 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. |
| 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 | ||||
| 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. |
| 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 | OperationDefinition.implicitRules, OperationDefinition.modifierExtension, OperationDefinition.name, OperationDefinition.status, OperationDefinition.kind, OperationDefinition.code, OperationDefinition.system, OperationDefinition.type, OperationDefinition.instance | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | OperationDefinition.modifierExtension | 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}')
|
This structure is derived from OperationDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| OperationDefinition |
C | 0..* | OperationDefinition(4.0.1) | Definition of an operation or a named query Constraints: opd-0 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
  meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
  extension:meta |
0..1 | Meta | DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels  (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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.
| |||||
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| 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 |
Σ | 0..1 | dateTime | Date 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 | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
 extension:name |
0..1 | string | DSTU2: Name of a individual to contact additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.contact.name Constraints: ext-1 | |||||
| extension:telecom |
0..* | ContactPoint | DSTU2: Contact details for individual or publisher additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.contact.telecom Constraints: ext-1 | |||||
| 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 | The context that 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 | |||||
| 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 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:base |
0..1 | Reference(Cross-version Profile for DSTU2.OperationDefinition for use in FHIR R4(0.1.0) | OperationDefinition) | DSTU2: base additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.base Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| resource |
Σ | 0..* | code | Types this operation applies to Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:type |
0..* | code | DSTU2: Invoke at resource level for these type additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.type Binding: R2ResourceTypesForR4 (0.1.0) (required): One of the resource types defined as part of FHIR. Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for code | |||||
| 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 Constraints: opd-1, opd-2, opd-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:profile |
0..1 | Reference(Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) | DSTU2: Profile on the type additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.parameter.profile Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:valueSet |
0..1 | Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R4(0.1.0) | ValueSet) | DSTU2: Source of value set additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.parameter.binding.valueSet Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| parameterName |
0..* | string | Name of parameter to include in overload | |||||
| comment |
0..1 | string | Comments to go on overload | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationDefinition.meta.security | Base | extensible |
SecurityLabels
|
📍4.0.1 | tx.fhir.org |
| OperationDefinition.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| OperationDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| OperationDefinition.text.status | Base | required | NarrativeStatus | 📍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 | tx.fhir.org |
| 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. |
| 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 | OperationDefinition.meta, OperationDefinition.meta.extension, OperationDefinition.meta.extension:meta, OperationDefinition.meta.versionId, OperationDefinition.meta.lastUpdated, OperationDefinition.meta.source, OperationDefinition.meta.profile, OperationDefinition.meta.security, OperationDefinition.meta.tag, OperationDefinition.implicitRules, OperationDefinition.language, OperationDefinition.text, OperationDefinition.text.extension, OperationDefinition.text.extension:text, OperationDefinition.text.status, OperationDefinition.text.div, OperationDefinition.extension, OperationDefinition.modifierExtension, OperationDefinition.url, OperationDefinition.version, OperationDefinition.name, OperationDefinition.title, OperationDefinition.status, OperationDefinition.kind, OperationDefinition.experimental, OperationDefinition.date, OperationDefinition.publisher, OperationDefinition.contact, OperationDefinition.contact.extension, OperationDefinition.contact.extension:name, OperationDefinition.contact.extension:telecom, OperationDefinition.contact.name, OperationDefinition.contact.telecom, OperationDefinition.description, OperationDefinition.useContext, OperationDefinition.jurisdiction, OperationDefinition.purpose, OperationDefinition.affectsState, OperationDefinition.code, OperationDefinition.comment, OperationDefinition.base, OperationDefinition.base.extension, OperationDefinition.base.extension:base, OperationDefinition.resource, OperationDefinition.resource.extension, OperationDefinition.resource.extension:type, OperationDefinition.system, OperationDefinition.type, OperationDefinition.instance, OperationDefinition.inputProfile, OperationDefinition.outputProfile, OperationDefinition.parameter, OperationDefinition.parameter.extension, OperationDefinition.parameter.modifierExtension, OperationDefinition.parameter.name, OperationDefinition.parameter.use, OperationDefinition.parameter.min, OperationDefinition.parameter.max, OperationDefinition.parameter.documentation, OperationDefinition.parameter.type, OperationDefinition.parameter.targetProfile, OperationDefinition.parameter.targetProfile.extension, OperationDefinition.parameter.targetProfile.extension:profile, OperationDefinition.parameter.searchType, OperationDefinition.parameter.binding, OperationDefinition.parameter.binding.extension, OperationDefinition.parameter.binding.extension:valueSet, OperationDefinition.parameter.binding.modifierExtension, OperationDefinition.parameter.binding.strength, OperationDefinition.parameter.binding.valueSet, OperationDefinition.parameter.referencedFrom, OperationDefinition.parameter.referencedFrom.extension, OperationDefinition.parameter.referencedFrom.modifierExtension, OperationDefinition.parameter.referencedFrom.source, OperationDefinition.parameter.referencedFrom.sourceId, OperationDefinition.parameter.part, OperationDefinition.overload, OperationDefinition.overload.extension, OperationDefinition.overload.modifierExtension, OperationDefinition.overload.parameterName, OperationDefinition.overload.comment | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | OperationDefinition.meta.extension, OperationDefinition.meta.extension:meta, OperationDefinition.text.extension, OperationDefinition.text.extension:text, OperationDefinition.extension, OperationDefinition.modifierExtension, OperationDefinition.contact.extension, OperationDefinition.contact.extension:name, OperationDefinition.contact.extension:telecom, OperationDefinition.base.extension, OperationDefinition.base.extension:base, OperationDefinition.resource.extension, OperationDefinition.resource.extension:type, OperationDefinition.parameter.extension, OperationDefinition.parameter.modifierExtension, OperationDefinition.parameter.targetProfile.extension, OperationDefinition.parameter.targetProfile.extension:profile, OperationDefinition.parameter.binding.extension, OperationDefinition.parameter.binding.extension:valueSet, OperationDefinition.parameter.binding.modifierExtension, OperationDefinition.parameter.referencedFrom.extension, OperationDefinition.parameter.referencedFrom.modifierExtension, OperationDefinition.overload.extension, OperationDefinition.overload.modifierExtension | 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')
|
| txt-1 | error | OperationDefinition.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | OperationDefinition.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from OperationDefinition
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| OperationDefinition |
C | 0..* | OperationDefinition(4.0.1) | Definition of an operation or a named query Constraints: opd-0 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| 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. |
| 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 | ||||
| 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. |
| 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 | OperationDefinition.implicitRules, OperationDefinition.modifierExtension, OperationDefinition.name, OperationDefinition.status, OperationDefinition.kind, OperationDefinition.code, OperationDefinition.system, OperationDefinition.type, OperationDefinition.instance | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | OperationDefinition.modifierExtension | 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}')
|
Differential View
This structure is derived from OperationDefinition
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| OperationDefinition |
C | 0..* | OperationDefinition(4.0.1) | Definition of an operation or a named query Constraints: opd-0 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | Meta | DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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.
| |||||
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| 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 |
Σ | 0..1 | dateTime | Date 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 | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:name |
0..1 | string | DSTU2: Name of a individual to contact additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.contact.name Constraints: ext-1 | |||||
| extension:telecom |
0..* | ContactPoint | DSTU2: Contact details for individual or publisher additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.contact.telecom Constraints: ext-1 | |||||
| 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 | The context that 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 | |||||
| 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 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:base |
0..1 | Reference(Cross-version Profile for DSTU2.OperationDefinition for use in FHIR R4(0.1.0) | OperationDefinition) | DSTU2: base additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.base Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| resource |
Σ | 0..* | code | Types this operation applies to Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:type |
0..* | code | DSTU2: Invoke at resource level for these type additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.type Binding: R2ResourceTypesForR4 (0.1.0) (required): One of the resource types defined as part of FHIR. Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for code | |||||
| 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 Constraints: opd-1, opd-2, opd-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:profile |
0..1 | Reference(Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R4(0.1.0) | StructureDefinition) | DSTU2: Profile on the type additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.parameter.profile Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for canonical | |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:valueSet |
0..1 | Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R4(0.1.0) | ValueSet) | DSTU2: Source of value set additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-OperationDefinition.parameter.binding.valueSet Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| parameterName |
0..* | string | Name of parameter to include in overload | |||||
| comment |
0..1 | string | Comments to go on overload | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationDefinition.meta.security | Base | extensible |
SecurityLabels
|
📍4.0.1 | tx.fhir.org |
| OperationDefinition.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| OperationDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| OperationDefinition.text.status | Base | required | NarrativeStatus | 📍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 | tx.fhir.org |
| 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. |
| 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 | OperationDefinition.meta, OperationDefinition.meta.extension, OperationDefinition.meta.extension:meta, OperationDefinition.meta.versionId, OperationDefinition.meta.lastUpdated, OperationDefinition.meta.source, OperationDefinition.meta.profile, OperationDefinition.meta.security, OperationDefinition.meta.tag, OperationDefinition.implicitRules, OperationDefinition.language, OperationDefinition.text, OperationDefinition.text.extension, OperationDefinition.text.extension:text, OperationDefinition.text.status, OperationDefinition.text.div, OperationDefinition.extension, OperationDefinition.modifierExtension, OperationDefinition.url, OperationDefinition.version, OperationDefinition.name, OperationDefinition.title, OperationDefinition.status, OperationDefinition.kind, OperationDefinition.experimental, OperationDefinition.date, OperationDefinition.publisher, OperationDefinition.contact, OperationDefinition.contact.extension, OperationDefinition.contact.extension:name, OperationDefinition.contact.extension:telecom, OperationDefinition.contact.name, OperationDefinition.contact.telecom, OperationDefinition.description, OperationDefinition.useContext, OperationDefinition.jurisdiction, OperationDefinition.purpose, OperationDefinition.affectsState, OperationDefinition.code, OperationDefinition.comment, OperationDefinition.base, OperationDefinition.base.extension, OperationDefinition.base.extension:base, OperationDefinition.resource, OperationDefinition.resource.extension, OperationDefinition.resource.extension:type, OperationDefinition.system, OperationDefinition.type, OperationDefinition.instance, OperationDefinition.inputProfile, OperationDefinition.outputProfile, OperationDefinition.parameter, OperationDefinition.parameter.extension, OperationDefinition.parameter.modifierExtension, OperationDefinition.parameter.name, OperationDefinition.parameter.use, OperationDefinition.parameter.min, OperationDefinition.parameter.max, OperationDefinition.parameter.documentation, OperationDefinition.parameter.type, OperationDefinition.parameter.targetProfile, OperationDefinition.parameter.targetProfile.extension, OperationDefinition.parameter.targetProfile.extension:profile, OperationDefinition.parameter.searchType, OperationDefinition.parameter.binding, OperationDefinition.parameter.binding.extension, OperationDefinition.parameter.binding.extension:valueSet, OperationDefinition.parameter.binding.modifierExtension, OperationDefinition.parameter.binding.strength, OperationDefinition.parameter.binding.valueSet, OperationDefinition.parameter.referencedFrom, OperationDefinition.parameter.referencedFrom.extension, OperationDefinition.parameter.referencedFrom.modifierExtension, OperationDefinition.parameter.referencedFrom.source, OperationDefinition.parameter.referencedFrom.sourceId, OperationDefinition.parameter.part, OperationDefinition.overload, OperationDefinition.overload.extension, OperationDefinition.overload.modifierExtension, OperationDefinition.overload.parameterName, OperationDefinition.overload.comment | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | OperationDefinition.meta.extension, OperationDefinition.meta.extension:meta, OperationDefinition.text.extension, OperationDefinition.text.extension:text, OperationDefinition.extension, OperationDefinition.modifierExtension, OperationDefinition.contact.extension, OperationDefinition.contact.extension:name, OperationDefinition.contact.extension:telecom, OperationDefinition.base.extension, OperationDefinition.base.extension:base, OperationDefinition.resource.extension, OperationDefinition.resource.extension:type, OperationDefinition.parameter.extension, OperationDefinition.parameter.modifierExtension, OperationDefinition.parameter.targetProfile.extension, OperationDefinition.parameter.targetProfile.extension:profile, OperationDefinition.parameter.binding.extension, OperationDefinition.parameter.binding.extension:valueSet, OperationDefinition.parameter.binding.modifierExtension, OperationDefinition.parameter.referencedFrom.extension, OperationDefinition.parameter.referencedFrom.modifierExtension, OperationDefinition.overload.extension, OperationDefinition.overload.modifierExtension | 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')
|
| txt-1 | error | OperationDefinition.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | OperationDefinition.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from OperationDefinition
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r2.r4#0.1.0 based on FHIR 4.0.1. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change