SPD - Service Provider Directory
0.2.0 - draft
SPD - Service Provider Directory
0.2.0 - draft
SPD - Service Provider Directory, published by TEHIK. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TEHIK-EE/ig-ee-spd/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir.ee/spd/StructureDefinition/ee-spd-operation-definition | Version: 0.2.0 | |||
| Draft as of 2026-08-06 | Computable Name: EESPDOperationDefinition | |||
Kirjeldab SPD poolt toetatud custom operatsiooni (nt PractitionerRole $lookup). Describes a custom operation supported by SPD, used for FHIR API discovery.
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 | Definition of an operation or a named query Interfaces Implemented: CanonicalResource Constraints: cnl-0, opd-5, opd-6, opd-7 | ||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| url |
ΣC | 1..1 | uri | Canonical identifier of this operation definition. Constraints: cnl-1 | ||||
| version |
Σ | 1..1 | string | Business version of the operation definition | ||||
| name |
ΣC | 1..1 | string | Name for this operation definition (computer friendly) | ||||
| title |
Σ | 1..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 |
ΣC | 1..1 | code | SPD kirjeldab ainult operatsioone (operation), mitte päringuid (query). Binding: OperationKind (required): Whether an operation is a normal operation or a query. Required Pattern: operation | ||||
| date |
Σ | 1..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 1..1 | string | Name of the publisher/steward (organization or individual) | ||||
 contact |
Σ | 1..* | ContactDetail | Contact details for the publisher | ||||
| description |
1..1 | markdown | Operatsiooni kirjeldus. | |||||
| code |
Σ | 1..1 | code | Operatsiooni kood, mille alusel operatsiooni käivitatakse (nt `$lookup` korral 'lookup'). | ||||
| resource |
Σ | 1..* | code | Ressursi tüüp(id), millele operatsioon rakendub, nt PractitionerRole. Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)
| ||||
| system |
Σ | 1..1 | boolean | Invoke at the system level? | ||||
| type |
Σ | 1..1 | boolean | Invoke at the type level? | ||||
| instance |
ΣC | 1..1 | boolean | Invoke on an instance? | ||||
 parameter |
C | 1..* | BackboneElement | Operatsiooni sisend- ja väljundparameetrid. Constraints: opd-1, opd-2, opd-3, opd-4 | ||||
 name |
C | 1..1 | code | Name in Parameters.parameter.name or in URL | ||||
| use |
C | 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 |
1..1 | markdown | Parameetri kirjeldus. (ee Parameetri kirjeldus.) | |||||
 type |
C | 1..1 | code | What type this parameter has Binding: FHIRTypes (required): A list of all the types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| OperationDefinition.kind | Base | required | Operation Kind | 📍5.0.0 | FHIR Std. |
| OperationDefinition.resource | Base | required | Version Independent Resource Types (All) | 📍5.0.0 | FHIR Std. |
| OperationDefinition.parameter.use | Base | required | Operation Parameter Use | 📍5.0.0 | FHIR Std. |
| OperationDefinition.parameter.type | Base | required | All FHIR Types | 📍5.0.0 | FHIR Std. |
| OperationDefinition.parameter.binding.strength | Base | required | BindingStrength | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | OperationDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
|
| cnl-1 | warning | OperationDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic |
exists() implies matches('^[^|# ]+$')
|
| 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-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, Canonical, or a Resource |
targetProfile.exists() implies (type = 'Reference' or type = 'canonical' or type.memberOf('http://hl7.org/fhir/ValueSet/resource-types'))
|
| opd-4 | error | OperationDefinition.parameter | SearchParamType can only be specified on in parameters |
(use = 'out') implies searchType.empty()
|
| opd-5 | error | OperationDefinition | A query operation cannot be defined at the instance level |
(kind = 'query') implies (instance = false)
|
| opd-6 | error | OperationDefinition | A query operation requires input parameters to have a search type |
(kind = 'query') implies (parameter.all((use = 'in' and searchType.exists()) or (use != 'in')))
|
| opd-7 | error | OperationDefinition | Named queries always have a single output parameter named 'result' of type Bundle |
(kind = 'query') implies ((parameter.where(use = 'out').count() = 1) and (parameter.where(use = 'out').all(name = 'result' and type = 'Bundle')))
|
This structure is derived from OperationDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| OperationDefinition |
0..* | OperationDefinition | Definition of an operation or a named query Interfaces Implemented: CanonicalResource | |
 contained |
0..0 | Contained, inline Resources | ||
 extension |
0..0 | Extension | ||
 modifierExtension |
0..0 | Extension | ||
| url |
1..1 | uri | Canonical identifier of this operation definition. | |
| version |
1..1 | string | Business version of the operation definition | |
| title |
1..1 | string | Name for this operation definition (human friendly) | |
| kind |
1..1 | code | SPD kirjeldab ainult operatsioone (operation), mitte päringuid (query). Required Pattern: operation | |
| date |
1..1 | dateTime | Date last changed | |
| publisher |
1..1 | string | Name of the publisher/steward (organization or individual) | |
| contact |
1..* | ContactDetail | Contact details for the publisher | |
| description |
1..1 | markdown | Operatsiooni kirjeldus. | |
| useContext |
0..0 | The context that the content is intended to support | ||
| code |
1..1 | code | Operatsiooni kood, mille alusel operatsiooni käivitatakse (nt `$lookup` korral 'lookup'). | |
| base |
0..0 | Marks this as a profile of the base | ||
| resource |
1..* | code | Ressursi tüüp(id), millele operatsioon rakendub, nt PractitionerRole. | |
| inputProfile |
0..0 | Validation information for in parameters | ||
| outputProfile |
0..0 | Validation information for out parameters | ||
 parameter |
1..* | BackboneElement | Operatsiooni sisend- ja väljundparameetrid. | |
 id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| scope |
0..0 | instance | type | system | ||
| documentation |
1..1 | markdown | Parameetri kirjeldus. (ee Parameetri kirjeldus.) | |
| type |
1..1 | code | What type this parameter has | |
| allowedType |
0..0 | Allowed sub-type this parameter can have (if type is abstract) | ||
| targetProfile |
0..0 | If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types | ||
| searchType |
0..0 | number | date | string | token | reference | composite | quantity | uri | special | ||
| binding |
0..0 | ValueSet details if this is coded | ||
| referencedFrom |
0..0 | References to this parameter | ||
| part |
0..0 | Parts of a nested Parameter | ||
| overload |
0..0 | Define overloaded variants for when generating code | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| OperationDefinition |
C | 0..* | OperationDefinition | Definition of an operation or a named query Interfaces Implemented: CanonicalResource Constraints: cnl-0, opd-5, opd-6, opd-7 | ||||
| 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: AllLanguages (required): IETF language tag for 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 | |||||
| url |
ΣC | 1..1 | uri | Canonical identifier of this operation definition. Constraints: cnl-1 | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the implementation guide (business identifier) | ||||
| version |
Σ | 1..1 | string | Business version of the operation definition | ||||
 versionAlgorithm[x] |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
| versionAlgorithmString |
string | |||||||
| versionAlgorithmCoding |
Coding | |||||||
| name |
ΣC | 1..1 | string | Name for this operation definition (computer friendly) | ||||
| title |
Σ | 1..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 |
ΣC | 1..1 | code | SPD kirjeldab ainult operatsioone (operation), mitte päringuid (query). Binding: OperationKind (required): Whether an operation is a normal operation or a query. Required Pattern: operation | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 1..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 1..1 | string | Name of the publisher/steward (organization or individual) | ||||
| contact |
Σ | 1..* | ContactDetail | Contact details for the publisher | ||||
| description |
1..1 | markdown | Operatsiooni kirjeldus. | |||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for operation definition (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this operation definition is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| copyrightLabel |
0..1 | string | Copyright holder and year(s) | |||||
| affectsState |
Σ | 0..1 | boolean | Whether content is changed by the operation | ||||
| code |
Σ | 1..1 | code | Operatsiooni kood, mille alusel operatsiooni käivitatakse (nt `$lookup` korral 'lookup'). | ||||
| comment |
0..1 | markdown | Additional information about use | |||||
| resource |
Σ | 1..* | code | Ressursi tüüp(id), millele operatsioon rakendub, nt PractitionerRole. Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)
| ||||
| system |
Σ | 1..1 | boolean | Invoke at the system level? | ||||
| type |
Σ | 1..1 | boolean | Invoke at the type level? | ||||
| instance |
ΣC | 1..1 | boolean | Invoke on an instance? | ||||
| parameter |
C | 1..* | BackboneElement | Operatsiooni sisend- ja väljundparameetrid. Constraints: opd-1, opd-2, opd-3, opd-4 | ||||
| name |
C | 1..1 | code | Name in Parameters.parameter.name or in URL | ||||
| use |
C | 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 |
1..1 | markdown | Parameetri kirjeldus. (ee Parameetri kirjeldus.) | |||||
| type |
C | 1..1 | code | What type this parameter has Binding: FHIRTypes (required): A list of all the types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| OperationDefinition.versionAlgorithm[x] | Base | extensible | Version Algorithm | 📍5.0.0 | FHIR Std. |
| OperationDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| OperationDefinition.kind | Base | required | Operation Kind | 📍5.0.0 | FHIR Std. |
| OperationDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
| OperationDefinition.resource | Base | required | Version Independent Resource Types (All) | 📍5.0.0 | FHIR Std. |
| OperationDefinition.parameter.use | Base | required | Operation Parameter Use | 📍5.0.0 | FHIR Std. |
| OperationDefinition.parameter.type | Base | required | All FHIR Types | 📍5.0.0 | FHIR Std. |
| OperationDefinition.parameter.binding.strength | Base | required | BindingStrength | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | OperationDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
|
| cnl-1 | warning | OperationDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic |
exists() implies matches('^[^|# ]+$')
|
| 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-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, Canonical, or a Resource |
targetProfile.exists() implies (type = 'Reference' or type = 'canonical' or type.memberOf('http://hl7.org/fhir/ValueSet/resource-types'))
|
| opd-4 | error | OperationDefinition.parameter | SearchParamType can only be specified on in parameters |
(use = 'out') implies searchType.empty()
|
| opd-5 | error | OperationDefinition | A query operation cannot be defined at the instance level |
(kind = 'query') implies (instance = false)
|
| opd-6 | error | OperationDefinition | A query operation requires input parameters to have a search type |
(kind = 'query') implies (parameter.all((use = 'in' and searchType.exists()) or (use != 'in')))
|
| opd-7 | error | OperationDefinition | Named queries always have a single output parameter named 'result' of type Bundle |
(kind = 'query') implies ((parameter.where(use = 'out').count() = 1) and (parameter.where(use = 'out').all(name = 'result' and type = 'Bundle')))
|
This structure is derived from OperationDefinition
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| OperationDefinition |
C | 0..* | OperationDefinition | Definition of an operation or a named query Interfaces Implemented: CanonicalResource Constraints: cnl-0, opd-5, opd-6, opd-7 | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| url |
ΣC | 1..1 | uri | Canonical identifier of this operation definition. Constraints: cnl-1 | ||||
| version |
Σ | 1..1 | string | Business version of the operation definition | ||||
| name |
ΣC | 1..1 | string | Name for this operation definition (computer friendly) | ||||
| title |
Σ | 1..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 |
ΣC | 1..1 | code | SPD kirjeldab ainult operatsioone (operation), mitte päringuid (query). Binding: OperationKind (required): Whether an operation is a normal operation or a query. Required Pattern: operation | ||||
| date |
Σ | 1..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 1..1 | string | Name of the publisher/steward (organization or individual) | ||||
| contact |
Σ | 1..* | ContactDetail | Contact details for the publisher | ||||
| description |
1..1 | markdown | Operatsiooni kirjeldus. | |||||
| code |
Σ | 1..1 | code | Operatsiooni kood, mille alusel operatsiooni käivitatakse (nt `$lookup` korral 'lookup'). | ||||
| resource |
Σ | 1..* | code | Ressursi tüüp(id), millele operatsioon rakendub, nt PractitionerRole. Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)
| ||||
| system |
Σ | 1..1 | boolean | Invoke at the system level? | ||||
| type |
Σ | 1..1 | boolean | Invoke at the type level? | ||||
| instance |
ΣC | 1..1 | boolean | Invoke on an instance? | ||||
| parameter |
C | 1..* | BackboneElement | Operatsiooni sisend- ja väljundparameetrid. Constraints: opd-1, opd-2, opd-3, opd-4 | ||||
| name |
C | 1..1 | code | Name in Parameters.parameter.name or in URL | ||||
| use |
C | 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 |
1..1 | markdown | Parameetri kirjeldus. (ee Parameetri kirjeldus.) | |||||
| type |
C | 1..1 | code | What type this parameter has Binding: FHIRTypes (required): A list of all the types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| OperationDefinition.kind | Base | required | Operation Kind | 📍5.0.0 | FHIR Std. |
| OperationDefinition.resource | Base | required | Version Independent Resource Types (All) | 📍5.0.0 | FHIR Std. |
| OperationDefinition.parameter.use | Base | required | Operation Parameter Use | 📍5.0.0 | FHIR Std. |
| OperationDefinition.parameter.type | Base | required | All FHIR Types | 📍5.0.0 | FHIR Std. |
| OperationDefinition.parameter.binding.strength | Base | required | BindingStrength | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | OperationDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
|
| cnl-1 | warning | OperationDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic |
exists() implies matches('^[^|# ]+$')
|
| 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-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, Canonical, or a Resource |
targetProfile.exists() implies (type = 'Reference' or type = 'canonical' or type.memberOf('http://hl7.org/fhir/ValueSet/resource-types'))
|
| opd-4 | error | OperationDefinition.parameter | SearchParamType can only be specified on in parameters |
(use = 'out') implies searchType.empty()
|
| opd-5 | error | OperationDefinition | A query operation cannot be defined at the instance level |
(kind = 'query') implies (instance = false)
|
| opd-6 | error | OperationDefinition | A query operation requires input parameters to have a search type |
(kind = 'query') implies (parameter.all((use = 'in' and searchType.exists()) or (use != 'in')))
|
| opd-7 | error | OperationDefinition | Named queries always have a single output parameter named 'result' of type Bundle |
(kind = 'query') implies ((parameter.where(use = 'out').count() = 1) and (parameter.where(use = 'out').all(name = 'result' and type = 'Bundle')))
|
Differential View
This structure is derived from OperationDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| OperationDefinition |
0..* | OperationDefinition | Definition of an operation or a named query Interfaces Implemented: CanonicalResource | |
| contained |
0..0 | Contained, inline Resources | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| url |
1..1 | uri | Canonical identifier of this operation definition. | |
| version |
1..1 | string | Business version of the operation definition | |
| title |
1..1 | string | Name for this operation definition (human friendly) | |
| kind |
1..1 | code | SPD kirjeldab ainult operatsioone (operation), mitte päringuid (query). Required Pattern: operation | |
| date |
1..1 | dateTime | Date last changed | |
| publisher |
1..1 | string | Name of the publisher/steward (organization or individual) | |
| contact |
1..* | ContactDetail | Contact details for the publisher | |
| description |
1..1 | markdown | Operatsiooni kirjeldus. | |
| useContext |
0..0 | The context that the content is intended to support | ||
| code |
1..1 | code | Operatsiooni kood, mille alusel operatsiooni käivitatakse (nt `$lookup` korral 'lookup'). | |
| base |
0..0 | Marks this as a profile of the base | ||
| resource |
1..* | code | Ressursi tüüp(id), millele operatsioon rakendub, nt PractitionerRole. | |
| inputProfile |
0..0 | Validation information for in parameters | ||
| outputProfile |
0..0 | Validation information for out parameters | ||
| parameter |
1..* | BackboneElement | Operatsiooni sisend- ja väljundparameetrid. | |
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| scope |
0..0 | instance | type | system | ||
| documentation |
1..1 | markdown | Parameetri kirjeldus. (ee Parameetri kirjeldus.) | |
| type |
1..1 | code | What type this parameter has | |
| allowedType |
0..0 | Allowed sub-type this parameter can have (if type is abstract) | ||
| targetProfile |
0..0 | If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types | ||
| searchType |
0..0 | number | date | string | token | reference | composite | quantity | uri | special | ||
| binding |
0..0 | ValueSet details if this is coded | ||
| referencedFrom |
0..0 | References to this parameter | ||
| part |
0..0 | Parts of a nested Parameter | ||
| overload |
0..0 | Define overloaded variants for when generating code | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| OperationDefinition |
C | 0..* | OperationDefinition | Definition of an operation or a named query Interfaces Implemented: CanonicalResource Constraints: cnl-0, opd-5, opd-6, opd-7 | ||||
| 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: AllLanguages (required): IETF language tag for 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 | |||||
| url |
ΣC | 1..1 | uri | Canonical identifier of this operation definition. Constraints: cnl-1 | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the implementation guide (business identifier) | ||||
| version |
Σ | 1..1 | string | Business version of the operation definition | ||||
| versionAlgorithm[x] |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
| versionAlgorithmString |
string | |||||||
| versionAlgorithmCoding |
Coding | |||||||
| name |
ΣC | 1..1 | string | Name for this operation definition (computer friendly) | ||||
| title |
Σ | 1..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 |
ΣC | 1..1 | code | SPD kirjeldab ainult operatsioone (operation), mitte päringuid (query). Binding: OperationKind (required): Whether an operation is a normal operation or a query. Required Pattern: operation | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 1..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 1..1 | string | Name of the publisher/steward (organization or individual) | ||||
| contact |
Σ | 1..* | ContactDetail | Contact details for the publisher | ||||
| description |
1..1 | markdown | Operatsiooni kirjeldus. | |||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for operation definition (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this operation definition is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| copyrightLabel |
0..1 | string | Copyright holder and year(s) | |||||
| affectsState |
Σ | 0..1 | boolean | Whether content is changed by the operation | ||||
| code |
Σ | 1..1 | code | Operatsiooni kood, mille alusel operatsiooni käivitatakse (nt `$lookup` korral 'lookup'). | ||||
| comment |
0..1 | markdown | Additional information about use | |||||
| resource |
Σ | 1..* | code | Ressursi tüüp(id), millele operatsioon rakendub, nt PractitionerRole. Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)
| ||||
| system |
Σ | 1..1 | boolean | Invoke at the system level? | ||||
| type |
Σ | 1..1 | boolean | Invoke at the type level? | ||||
| instance |
ΣC | 1..1 | boolean | Invoke on an instance? | ||||
| parameter |
C | 1..* | BackboneElement | Operatsiooni sisend- ja väljundparameetrid. Constraints: opd-1, opd-2, opd-3, opd-4 | ||||
| name |
C | 1..1 | code | Name in Parameters.parameter.name or in URL | ||||
| use |
C | 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 |
1..1 | markdown | Parameetri kirjeldus. (ee Parameetri kirjeldus.) | |||||
| type |
C | 1..1 | code | What type this parameter has Binding: FHIRTypes (required): A list of all the types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| OperationDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| OperationDefinition.versionAlgorithm[x] | Base | extensible | Version Algorithm | 📍5.0.0 | FHIR Std. |
| OperationDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| OperationDefinition.kind | Base | required | Operation Kind | 📍5.0.0 | FHIR Std. |
| OperationDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
| OperationDefinition.resource | Base | required | Version Independent Resource Types (All) | 📍5.0.0 | FHIR Std. |
| OperationDefinition.parameter.use | Base | required | Operation Parameter Use | 📍5.0.0 | FHIR Std. |
| OperationDefinition.parameter.type | Base | required | All FHIR Types | 📍5.0.0 | FHIR Std. |
| OperationDefinition.parameter.binding.strength | Base | required | BindingStrength | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | OperationDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
|
| cnl-1 | warning | OperationDefinition.url | URL should not contain | or # - these characters make processing canonical references problematic |
exists() implies matches('^[^|# ]+$')
|
| 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-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, Canonical, or a Resource |
targetProfile.exists() implies (type = 'Reference' or type = 'canonical' or type.memberOf('http://hl7.org/fhir/ValueSet/resource-types'))
|
| opd-4 | error | OperationDefinition.parameter | SearchParamType can only be specified on in parameters |
(use = 'out') implies searchType.empty()
|
| opd-5 | error | OperationDefinition | A query operation cannot be defined at the instance level |
(kind = 'query') implies (instance = false)
|
| opd-6 | error | OperationDefinition | A query operation requires input parameters to have a search type |
(kind = 'query') implies (parameter.all((use = 'in' and searchType.exists()) or (use != 'in')))
|
| opd-7 | error | OperationDefinition | Named queries always have a single output parameter named 'result' of type Bundle |
(kind = 'query') implies ((parameter.where(use = 'out').count() = 1) and (parameter.where(use = 'out').all(name = 'result' and type = 'Bundle')))
|
This structure is derived from OperationDefinition
Other representations of profile: CSV, Excel, Schematron