1.0.0 - release

Publish Box goes here

Resource Profile: OperationDefinitionUnlinkFromHealthIssue

Official URL: https://fhir.cambio.se/StructureDefinition/OperationDefinitionUnlinkFromHealthIssue/v1 Version: 1.0.0
Active as of 2025-10-27 Computable Name: OperationDefinitionUnlinkFromHealthIssue

Introduction

The operation $unlinkFromHealthIssue is an operation performed on the profile QuestionnaireResponseSe, which is based on the QuestionnaireResponse resource. This operation is used to disconnect the link between a ConditionHealthIssueSe and a QuestionnaireResponseSe.

The formal computable definition of the operation is specified by the OperationDefinitionUnlinkFromHealthIssue profile, derived from the OperationDefinition resource in FHIR R4.

To pass information into the operation, the ParametersHealthIssueReferenceSe profile is used, which is based on the Parameters resource in FHIR R4.

Intended Use

The API is designed to disconnect the link between a ConditionHealthIssueSe and a QuestionnaireResponseSe belonging to the same patient. Only one ConditionHealthIssueSe can be unlinked from a QuestionnaireResponseSe at a time.

The literal ID (COSMIC resource ID) of the QuestionnaireResponseSe to be unlinked must be provided in the API path. This ensures that the QuestionnaireResponseSe referenced exists in COSMIC.

The literal ID (COSMIC resource ID) of the ConditionHealthIssueSe to be unlinked must be included in the API request body using the ParametersHealthIssueReferenceSe profile.

This API is recommended for use by healthcare professionals.

Specific Rules and Limitations

Type Description
Limitation Only one ConditionHealthIssueSe can be unlinked at a time; unlinking multiple is not permitted.

Versions

COS version Profile version Required COSMIC version Date Description
TBA 1.0.0 TBA tba Initial version, support for POST $unlinkFromHealthIssue.

Supported Operations

HTTP Method Description Scope
POST Disconnect the link between a QuestionnaireResponseSe and a ConditionHealthIssueSe belonging to the same patient. system/QuestionnaireResponse.write OR user/QuestionnaireResponse.write OR patient/QuestionnaireResponse.write

Input Parameters

  • Path parameters: The literal ID of the QuestionnaireResponse
  • Body parameters: The literal ID of the ConditionHealthIssueSe to be unlinked via the ParametersHealthIssueReferenceSe profile

Supported Queries

  1. POST [baseURL]/QuestionnaireResponse/{id}/$unlinkFromHealthIssue

Response Codes

Scenario Response code Description
API request is a success. 200 OK -
Path parameter "id": Empty 400 Bad Request Invalid request: The FHIR endpoint on this server does not know how to handle POST operation[QuestionnaireResponse/$unlinkFromHealthIssue] with parameters [[]]
Path parameter "id": Journal note doesn't exist in Cosmic 404 Not Found Invalid parameters: QuestionnaireResponseSe not found.
Path parameter "id": Invalid input type 500 Internal Server Error -
Body parameter "resourceType": Empty, NULL, or not supplied 400 Bad Request HAPI-0450: Failed to parse request body as JSON resource. Error was: HAPI-1838: Invalid JSON content detected, missing required element: 'resourceType'
Body parameter "resourceType": A different value than 'Parameters' 400 Bad Request HAPI-0450: Failed to parse request body as JSON resource. Error was: HAPI-1684: Unknown resource name "<_supplied value_="">" (this name is not known in FHIR version \"R4\")
Body parameter "meta": Empty, NULL, or Not supplied 400 Bad Request Parameters must contain a valid meta profile
Body parameter "meta.profile": Empty 400 Bad Request HAPI-0450: Failed to parse request body as JSON resource. Error was: HAPI-1821: [element="profile"] Invalid attribute value "": Attribute value must not be empty ("")
Body parameter "meta.profile": NULL 400 Bad Request Parameters must contain a valid meta profile
Body parameter "meta.profile": Not supplied 400 Bad Request Parameters must contain a valid meta profile
Body parameter "meta.profile": Wrong profile url value 422 Unprocessable Entity Profile reference 'https://fhir.cambio.se/StructureDefinition/ParametersHealthIssueReferenceSee/v1' has not been checked because it is unknown
Body parameter "parameter": Empty, NULL, or Not supplied 422 Unprocessable Entity Parameters.parameter: minimum required = 1, but only found 0 (from https://fhir.cambio.se/StructureDefinition/ParametersHealthIssueReferenceSe/v1)
Body parameter "parameter.name": Empty 400 Bad Request HAPI-0450: Failed to parse request body as JSON resource. Error was: HAPI-1821: [element="name"] Invalid attribute value "": Attribute value must not be empty ("")
Body parameter "parameter.name": NULL, or Not supplied 422 Unprocessable Entity Parameters.parameter.name: minimum required = 1, but only found 0 (from https://fhir.cambio.se/StructureDefinition/ParametersHealthIssueReferenceSe/v1)
Body parameter "parameter.name": A different value other than "HealthIssueReference" 422 Unprocessable Entity Value is '<_supplied value_="">' but must be 'HealthIssueReference'
Body parameter "parameter.valueReference": Empty, or Not supplied 422 Unprocessable Entity inv-1: 'A parameter must have one and only one of (value, resource, part)' Rule 'A parameter must have one and only one of (value, resource, part)' Failed
Body parameter "parameter.valueReference.reference": Empty 400 Bad Request HAPI-0450: Failed to parse request body as JSON resource. Error was: HAPI-1821: [element="reference"] Invalid attribute value "": Attribute value must not be empty ("")
Body parameter "parameter.valueReference.reference": NULL, or Not supplied 422 Unprocessable Entity inv-1: 'A parameter must have one and only one of (value, resource, part)' Rule 'A parameter must have one and only one of (value, resource, part)' Failed
Body parameter "parameter.valueReference.reference": Not in the format 'Codition/hi-< id >' 400 Bad Request Invalid request: The supplied condition ID is not supported
Body parameter "parameter.valueReference.reference": Invalid input type 400 Bad Request HealthIssueReference must contain a valid reference
Body parameter "parameter.valueReference.reference": Health issue doesn't exist in Cosmic 400 Bad Request Invalid parameters: ConditionHealthIssueSe not found
If a link doesn't exist for the supplied health issue and journal note. 400 Bad Request The supplied QuestionnaireResponse & ConditionHealthIssue are not linked
If an unsupported scope is supplied. 403 Forbidden -

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition C 0..* OperationDefinition Definition of the operation '$unlinkFromHealthIssue'
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
... name ΣC 1..1 string Name for this operation definition (computer friendly)
Fixed Value: UnlinkFromHealthIssue
... kind Σ 1..1 code operation | query
Binding: OperationKind (required): Whether an operation is a normal operation or a query.
Fixed Value: operation
... code Σ 1..1 code Name used to invoke the operation
Fixed Value: unlinkFromHealthIssue
... system Σ 1..1 boolean Invoke at the system level?
Fixed Value: false
... type Σ 1..1 boolean Invoke at the type level?
Fixed Value: false
... instance Σ 1..1 boolean Invoke on an instance?
Fixed Value: true
... inputProfile 1..1 canonical(StructureDefinition) Validation information for in parameters
Required Pattern: https://fhir.cambio.se/StructureDefinition/ParametersHealthIssueReferenceSe/v1
... parameter C 1..1 BackboneElement Parameters for the operation
Constraints: opd-1, opd-2, opd-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: healthIssueId
.... use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
Fixed Value: in
.... min 1..1 integer Minimum Cardinality
Fixed Value: 1
.... max 1..1 string Maximum Cardinality (a number or *)
Fixed Value: 1
.... 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.
Fixed Value: Reference
.... targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets

Required Pattern: https://fhir.cambio.se/StructureDefinition/ConditionHealthIssueSe/v1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
OperationDefinition.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
OperationDefinition.kindrequiredFixed Value: operation
http://hl7.org/fhir/ValueSet/operation-kind|4.0.1
From the FHIR Standard
OperationDefinition.parameter.userequiredFixed Value: in
http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1
From the FHIR Standard
OperationDefinition.parameter.typerequiredFixed Value: Reference
http://hl7.org/fhir/ValueSet/all-types|4.0.1
From the FHIR Standard
OperationDefinition.parameter.binding.strengthrequiredBindingStrength
http://hl7.org/fhir/ValueSet/binding-strength|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOperationDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOperationDefinitionIf 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-4errorOperationDefinitionIf 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-5errorOperationDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOperationDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
opd-0warningOperationDefinitionName 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-1errorOperationDefinition.parameterEither a type must be provided, or parts
: type.exists() or part.exists()
opd-2errorOperationDefinition.parameterA search type can only be specified for parameters of type string
: searchType.exists() implies type = 'string'
opd-3errorOperationDefinition.parameterA 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition 0..* OperationDefinition Definition of the operation '$unlinkFromHealthIssue'
... url 0..0
... version 0..0
... name 1..1 string Name for this operation definition (computer friendly)
Fixed Value: UnlinkFromHealthIssue
... status 1..1 code draft | active | retired | unknown
Fixed Value: active
... kind 1..1 code operation | query
Fixed Value: operation
... experimental 0..0
... date 0..0
... publisher 0..0
... contact 0..0
... description 0..0
... useContext 0..0
... jurisdiction 0..0
... purpose 0..0
... affectsState 0..0
... code 1..1 code Name used to invoke the operation
Fixed Value: unlinkFromHealthIssue
... comment 0..0
... base 0..0
... resource 0..0
... system 1..1 boolean Invoke at the system level?
Fixed Value: false
... type 1..1 boolean Invoke at the type level?
Fixed Value: false
... instance 1..1 boolean Invoke on an instance?
Fixed Value: true
... inputProfile 1..1 canonical(StructureDefinition) Validation information for in parameters
Required Pattern: https://fhir.cambio.se/StructureDefinition/ParametersHealthIssueReferenceSe/v1
... outputProfile 0..0
... parameter 1..1 BackboneElement Parameters for the operation
.... name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: healthIssueId
.... use 1..1 code in | out
Fixed Value: in
.... min 1..1 integer Minimum Cardinality
Fixed Value: 1
.... max 1..1 string Maximum Cardinality (a number or *)
Fixed Value: 1
.... documentation 0..1 string Description of meaning/use
.... type 0..1 code What type this parameter has
Fixed Value: Reference
.... targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets
Required Pattern: https://fhir.cambio.se/StructureDefinition/ConditionHealthIssueSe/v1
.... searchType 0..0
.... binding 0..0
.... referencedFrom 0..0
.... part 0..0
... overload 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition C 0..* OperationDefinition Definition of the operation '$unlinkFromHealthIssue'
Constraints: opd-0
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... name ΣC 1..1 string Name for this operation definition (computer friendly)
Fixed Value: UnlinkFromHealthIssue
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Fixed Value: active
... kind Σ 1..1 code operation | query
Binding: OperationKind (required): Whether an operation is a normal operation or a query.
Fixed Value: operation
... code Σ 1..1 code Name used to invoke the operation
Fixed Value: unlinkFromHealthIssue
... system Σ 1..1 boolean Invoke at the system level?
Fixed Value: false
... type Σ 1..1 boolean Invoke at the type level?
Fixed Value: false
... instance Σ 1..1 boolean Invoke on an instance?
Fixed Value: true
... inputProfile 1..1 canonical(StructureDefinition) Validation information for in parameters
Required Pattern: https://fhir.cambio.se/StructureDefinition/ParametersHealthIssueReferenceSe/v1
... parameter C 1..1 BackboneElement Parameters for the operation
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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: healthIssueId
.... use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
Fixed Value: in
.... min 1..1 integer Minimum Cardinality
Fixed Value: 1
.... max 1..1 string Maximum Cardinality (a number or *)
Fixed Value: 1
.... 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.
Fixed Value: Reference
.... targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets

Required Pattern: https://fhir.cambio.se/StructureDefinition/ConditionHealthIssueSe/v1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
OperationDefinition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
OperationDefinition.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
OperationDefinition.kindrequiredFixed Value: operation
http://hl7.org/fhir/ValueSet/operation-kind|4.0.1
From the FHIR Standard
OperationDefinition.parameter.userequiredFixed Value: in
http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1
From the FHIR Standard
OperationDefinition.parameter.typerequiredFixed Value: Reference
http://hl7.org/fhir/ValueSet/all-types|4.0.1
From the FHIR Standard
OperationDefinition.parameter.binding.strengthrequiredBindingStrength
http://hl7.org/fhir/ValueSet/binding-strength|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOperationDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOperationDefinitionIf 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-4errorOperationDefinitionIf 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-5errorOperationDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOperationDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
opd-0warningOperationDefinitionName 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-1errorOperationDefinition.parameterEither a type must be provided, or parts
: type.exists() or part.exists()
opd-2errorOperationDefinition.parameterA search type can only be specified for parameters of type string
: searchType.exists() implies type = 'string'
opd-3errorOperationDefinition.parameterA 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: 2 elements
Fixed: 12 elements
Prohibited: 21 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition C 0..* OperationDefinition Definition of the operation '$unlinkFromHealthIssue'
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
... name ΣC 1..1 string Name for this operation definition (computer friendly)
Fixed Value: UnlinkFromHealthIssue
... kind Σ 1..1 code operation | query
Binding: OperationKind (required): Whether an operation is a normal operation or a query.
Fixed Value: operation
... code Σ 1..1 code Name used to invoke the operation
Fixed Value: unlinkFromHealthIssue
... system Σ 1..1 boolean Invoke at the system level?
Fixed Value: false
... type Σ 1..1 boolean Invoke at the type level?
Fixed Value: false
... instance Σ 1..1 boolean Invoke on an instance?
Fixed Value: true
... inputProfile 1..1 canonical(StructureDefinition) Validation information for in parameters
Required Pattern: https://fhir.cambio.se/StructureDefinition/ParametersHealthIssueReferenceSe/v1
... parameter C 1..1 BackboneElement Parameters for the operation
Constraints: opd-1, opd-2, opd-3
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: healthIssueId
.... use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
Fixed Value: in
.... min 1..1 integer Minimum Cardinality
Fixed Value: 1
.... max 1..1 string Maximum Cardinality (a number or *)
Fixed Value: 1
.... 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.
Fixed Value: Reference
.... targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets

Required Pattern: https://fhir.cambio.se/StructureDefinition/ConditionHealthIssueSe/v1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
OperationDefinition.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
OperationDefinition.kindrequiredFixed Value: operation
http://hl7.org/fhir/ValueSet/operation-kind|4.0.1
From the FHIR Standard
OperationDefinition.parameter.userequiredFixed Value: in
http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1
From the FHIR Standard
OperationDefinition.parameter.typerequiredFixed Value: Reference
http://hl7.org/fhir/ValueSet/all-types|4.0.1
From the FHIR Standard
OperationDefinition.parameter.binding.strengthrequiredBindingStrength
http://hl7.org/fhir/ValueSet/binding-strength|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOperationDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOperationDefinitionIf 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-4errorOperationDefinitionIf 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-5errorOperationDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOperationDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
opd-0warningOperationDefinitionName 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-1errorOperationDefinition.parameterEither a type must be provided, or parts
: type.exists() or part.exists()
opd-2errorOperationDefinition.parameterA search type can only be specified for parameters of type string
: searchType.exists() implies type = 'string'
opd-3errorOperationDefinition.parameterA targetProfile can only be specified for parameters of type Reference or Canonical
: targetProfile.exists() implies (type = 'Reference' or type = 'canonical')

Differential View

This structure is derived from OperationDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition 0..* OperationDefinition Definition of the operation '$unlinkFromHealthIssue'
... url 0..0
... version 0..0
... name 1..1 string Name for this operation definition (computer friendly)
Fixed Value: UnlinkFromHealthIssue
... status 1..1 code draft | active | retired | unknown
Fixed Value: active
... kind 1..1 code operation | query
Fixed Value: operation
... experimental 0..0
... date 0..0
... publisher 0..0
... contact 0..0
... description 0..0
... useContext 0..0
... jurisdiction 0..0
... purpose 0..0
... affectsState 0..0
... code 1..1 code Name used to invoke the operation
Fixed Value: unlinkFromHealthIssue
... comment 0..0
... base 0..0
... resource 0..0
... system 1..1 boolean Invoke at the system level?
Fixed Value: false
... type 1..1 boolean Invoke at the type level?
Fixed Value: false
... instance 1..1 boolean Invoke on an instance?
Fixed Value: true
... inputProfile 1..1 canonical(StructureDefinition) Validation information for in parameters
Required Pattern: https://fhir.cambio.se/StructureDefinition/ParametersHealthIssueReferenceSe/v1
... outputProfile 0..0
... parameter 1..1 BackboneElement Parameters for the operation
.... name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: healthIssueId
.... use 1..1 code in | out
Fixed Value: in
.... min 1..1 integer Minimum Cardinality
Fixed Value: 1
.... max 1..1 string Maximum Cardinality (a number or *)
Fixed Value: 1
.... documentation 0..1 string Description of meaning/use
.... type 0..1 code What type this parameter has
Fixed Value: Reference
.... targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets
Required Pattern: https://fhir.cambio.se/StructureDefinition/ConditionHealthIssueSe/v1
.... searchType 0..0
.... binding 0..0
.... referencedFrom 0..0
.... part 0..0
... overload 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. OperationDefinition C 0..* OperationDefinition Definition of the operation '$unlinkFromHealthIssue'
Constraints: opd-0
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... name ΣC 1..1 string Name for this operation definition (computer friendly)
Fixed Value: UnlinkFromHealthIssue
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Fixed Value: active
... kind Σ 1..1 code operation | query
Binding: OperationKind (required): Whether an operation is a normal operation or a query.
Fixed Value: operation
... code Σ 1..1 code Name used to invoke the operation
Fixed Value: unlinkFromHealthIssue
... system Σ 1..1 boolean Invoke at the system level?
Fixed Value: false
... type Σ 1..1 boolean Invoke at the type level?
Fixed Value: false
... instance Σ 1..1 boolean Invoke on an instance?
Fixed Value: true
... inputProfile 1..1 canonical(StructureDefinition) Validation information for in parameters
Required Pattern: https://fhir.cambio.se/StructureDefinition/ParametersHealthIssueReferenceSe/v1
... parameter C 1..1 BackboneElement Parameters for the operation
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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 code Name in Parameters.parameter.name or in URL
Fixed Value: healthIssueId
.... use 1..1 code in | out
Binding: OperationParameterUse (required): Whether an operation parameter is an input or an output parameter.
Fixed Value: in
.... min 1..1 integer Minimum Cardinality
Fixed Value: 1
.... max 1..1 string Maximum Cardinality (a number or *)
Fixed Value: 1
.... 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.
Fixed Value: Reference
.... targetProfile 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets

Required Pattern: https://fhir.cambio.se/StructureDefinition/ConditionHealthIssueSe/v1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
OperationDefinition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
OperationDefinition.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
From the FHIR Standard
OperationDefinition.kindrequiredFixed Value: operation
http://hl7.org/fhir/ValueSet/operation-kind|4.0.1
From the FHIR Standard
OperationDefinition.parameter.userequiredFixed Value: in
http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1
From the FHIR Standard
OperationDefinition.parameter.typerequiredFixed Value: Reference
http://hl7.org/fhir/ValueSet/all-types|4.0.1
From the FHIR Standard
OperationDefinition.parameter.binding.strengthrequiredBindingStrength
http://hl7.org/fhir/ValueSet/binding-strength|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOperationDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOperationDefinitionIf 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-4errorOperationDefinitionIf 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-5errorOperationDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOperationDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
opd-0warningOperationDefinitionName 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-1errorOperationDefinition.parameterEither a type must be provided, or parts
: type.exists() or part.exists()
opd-2errorOperationDefinition.parameterA search type can only be specified for parameters of type string
: searchType.exists() implies type = 'string'
opd-3errorOperationDefinition.parameterA 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: 2 elements
Fixed: 12 elements
Prohibited: 21 elements

 

Other representations of profile: CSV, Excel, Schematron