Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot2 - Ballot
Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot2 - Ballot
This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot2: STU1 Ballot 2) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareableoperationdefinition | Version: 1.0.0-ballot2 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: CRMIShareableOperationDefinition | ||
Enforces the minimum information set for the operation definition metadata required by HL7 and other organizations that share and publish operation definitions
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from OperationDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  OperationDefinition | 1..1 | OperationDefinition | Definition of an operation or a named query | |
  knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) |
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) |
| versionPolicy | S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact |
 url | S | 1..1 | uri | Canonical identifier for this operation definition, represented as a URI (globally unique) |
| version | S | 1..1 | string | Business version of the operation definition |
| name | S | 1..1 | string | Name for this operation definition (computer friendly) |
| title | S | 1..1 | string | Name for this operation definition (human friendly) |
| status | S | 1..1 | code | draft | active | retired | unknown |
| experimental | S | 1..1 | boolean | For testing purposes, not real usage |
| publisher | S | 0..1 | string | Name of the publisher (organization or individual) |
 description | S | 1..1 | markdown | Natural language description of the operation definition |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OperationDefinition | C | 1..1 | OperationDefinition | Definition of an operation or a named query |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) |
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) |
| versionPolicy | S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 1..1 | uri | Canonical identifier for this operation definition, represented as a URI (globally unique) |
| version | SΣ | 1..1 | string | Business version of the operation definition |
| name | SΣC | 1..1 | string | Name for this operation definition (computer friendly) |
| title | SΣ | 1..1 | string | Name for this operation definition (human friendly) |
| status | ?!SΣ | 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 | SΣ | 1..1 | boolean | For testing purposes, not real usage |
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| description | S | 1..1 | markdown | Natural language description of the operation definition |
| 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 | Conformance | ValueSet |
| OperationDefinition.status | required | PublicationStatus |
| OperationDefinition.kind | required | OperationKind |
| 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 | ||||
| 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.
| |||||
| 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 | |||||
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) | ||||
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | ||||
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | ||||
| versionPolicy | S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | SΣ | 1..1 | uri | Canonical identifier for this operation definition, represented as a URI (globally unique) | ||||
| version | SΣ | 1..1 | string | Business version of the operation definition | ||||
| name | SΣC | 1..1 | string | Name for this operation definition (computer friendly) | ||||
| title | SΣ | 1..1 | string | Name for this operation definition (human friendly) | ||||
| status | ?!SΣ | 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 | SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
| date | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | S | 1..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 | ||||
| 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 | ||||
 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 | ||||||||
| Path | Conformance | ValueSet | ||||
| OperationDefinition.language | preferred | CommonLanguages
| ||||
| OperationDefinition.status | required | PublicationStatus | ||||
| OperationDefinition.kind | required | OperationKind | ||||
| OperationDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| OperationDefinition.resource | required | ResourceType | ||||
| OperationDefinition.parameter.use | required | OperationParameterUse | ||||
| OperationDefinition.parameter.type | required | FHIRAllTypes | ||||
| OperationDefinition.parameter.searchType | required | SearchParamType | ||||
| OperationDefinition.parameter.binding.strength | required | BindingStrength |
| 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: 5 elements
Must-Support: 13 elements
Extensions
This structure refers to these extensions:
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 | |
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) |
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) |
| versionPolicy | S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact |
| url | S | 1..1 | uri | Canonical identifier for this operation definition, represented as a URI (globally unique) |
| version | S | 1..1 | string | Business version of the operation definition |
| name | S | 1..1 | string | Name for this operation definition (computer friendly) |
| title | S | 1..1 | string | Name for this operation definition (human friendly) |
| status | S | 1..1 | code | draft | active | retired | unknown |
| experimental | S | 1..1 | boolean | For testing purposes, not real usage |
| publisher | S | 0..1 | string | Name of the publisher (organization or individual) |
| description | S | 1..1 | markdown | Natural language description of the operation definition |
| 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 |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) |
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) |
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) |
| versionPolicy | S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 1..1 | uri | Canonical identifier for this operation definition, represented as a URI (globally unique) |
| version | SΣ | 1..1 | string | Business version of the operation definition |
| name | SΣC | 1..1 | string | Name for this operation definition (computer friendly) |
| title | SΣ | 1..1 | string | Name for this operation definition (human friendly) |
| status | ?!SΣ | 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 | SΣ | 1..1 | boolean | For testing purposes, not real usage |
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| description | S | 1..1 | markdown | Natural language description of the operation definition |
| 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 | Conformance | ValueSet |
| OperationDefinition.status | required | PublicationStatus |
| OperationDefinition.kind | required | OperationKind |
| 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 | ||||
| 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.
| |||||
| 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 | |||||
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required) | ||||
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) | ||||
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | ||||
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | ||||
| versionPolicy | S | 0..1 | CodeableConcept | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | SΣ | 1..1 | uri | Canonical identifier for this operation definition, represented as a URI (globally unique) | ||||
| version | SΣ | 1..1 | string | Business version of the operation definition | ||||
| name | SΣC | 1..1 | string | Name for this operation definition (computer friendly) | ||||
| title | SΣ | 1..1 | string | Name for this operation definition (human friendly) | ||||
| status | ?!SΣ | 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 | SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
| date | Σ | 0..1 | dateTime | Date last changed | ||||
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | S | 1..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 | ||||
| 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 | ||||
| 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 | ||||||||
| Path | Conformance | ValueSet | ||||
| OperationDefinition.language | preferred | CommonLanguages
| ||||
| OperationDefinition.status | required | PublicationStatus | ||||
| OperationDefinition.kind | required | OperationKind | ||||
| OperationDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| OperationDefinition.resource | required | ResourceType | ||||
| OperationDefinition.parameter.use | required | OperationParameterUse | ||||
| OperationDefinition.parameter.type | required | FHIRAllTypes | ||||
| OperationDefinition.parameter.searchType | required | SearchParamType | ||||
| OperationDefinition.parameter.binding.strength | required | BindingStrength |
| 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: 5 elements
Must-Support: 13 elements
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#1.0.0-ballot2 based on FHIR 4.0.1. Generated 2023-12-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change