Prescription Search Support
1.0.0 - STU1 Belgium flag

Prescription Search Support, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/pss/ and changes regularly. See the Directory of published versions

Resource Profile: Antimicrobial Guidance Response

Official URL: https://www.ehealth.fgov.be/standards/fhir/pss/StructureDefinition/be-antimicro-guidance-response Version: 1.0.0
Draft as of 2024-11-13 Computable Name: BeAntiMicroGuidanceResponse

Profile for GuidanceResponse with specific constraints for antimicrobial guidance response.

Usage:

Formal Views of Profile Content

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

This structure is derived from GuidanceResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse GuidanceResponse
... Slices for module[x] 1..1 uri, canonical(), CodeableConcept What guidance was requested
Slice: Unordered, Open by type:$this
.... module[x]:moduleUri 0..1 uri What guidance was requested
Required Pattern: /antimicroGuidanceRequest
... reasonCode
.... coding S 1..1 Coding Code defined by a terminology system
..... system 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
... evaluationMessage 0..* Reference(Antimicrobial Operation Outcome) Messages resulting from the evaluation of the artifact or artifacts

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse 0..* GuidanceResponse The formal response to a guidance request
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for module[x] Σ 1..1 What guidance was requested
Slice: Unordered, Open by type:$this
.... moduleUri uri
.... moduleCanonical canonical(Any)
.... moduleCodeableConcept CodeableConcept
.... module[x]:moduleUri Σ 0..1 uri What guidance was requested
Required Pattern: /antimicroGuidanceRequest
... reasonCode 0..* CodeableConcept Why guidance is needed
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
... evaluationMessage 0..* Reference(Antimicrobial Operation Outcome) Messages resulting from the evaluation of the artifact or artifacts
... outputParameters 0..1 Reference(Antimicrobial Parameters) The output parameters of the evaluation, if any

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GuidanceResponse.statusrequiredGuidanceResponseStatus
http://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGuidanceResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGuidanceResponseIf 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-4errorGuidanceResponseIf 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-5errorGuidanceResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGuidanceResponseA 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse 0..* GuidanceResponse The formal response to a guidance request
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... requestIdentifier Σ 0..1 Identifier The identifier of the request associated with this response, if any
... identifier Σ 0..* Identifier Business identifier
... Slices for module[x] Σ 1..1 What guidance was requested
Slice: Unordered, Open by type:$this
.... moduleUri uri
.... moduleCanonical canonical(Any)
.... moduleCodeableConcept CodeableConcept
.... module[x]:moduleUri Σ 0..1 uri What guidance was requested
Required Pattern: /antimicroGuidanceRequest
... status ?!Σ 1..1 code success | data-requested | data-required | in-progress | failure | entered-in-error
Binding: GuidanceResponseStatus (required): The status of a guidance response.

... subject 0..1 Reference(Patient | Group) Patient the request was performed for
... encounter 0..1 Reference(Encounter) Encounter during which the response was returned
... occurrenceDateTime 0..1 dateTime When the guidance response was processed
... performer 0..1 Reference(Device) Device returning the guidance
... reasonCode 0..* CodeableConcept Why guidance is needed
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why guidance is needed
... note 0..* Annotation Additional notes about the response
... evaluationMessage 0..* Reference(Antimicrobial Operation Outcome) Messages resulting from the evaluation of the artifact or artifacts
... outputParameters 0..1 Reference(Antimicrobial Parameters) The output parameters of the evaluation, if any
... result 0..1 Reference(CarePlan | RequestGroup) Proposed actions, if any
... dataRequirement 0..* DataRequirement Additional required data

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GuidanceResponse.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
GuidanceResponse.statusrequiredGuidanceResponseStatus
http://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGuidanceResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGuidanceResponseIf 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-4errorGuidanceResponseIf 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-5errorGuidanceResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGuidanceResponseA 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()

This structure is derived from GuidanceResponse

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 1 element
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of GuidanceResponse.module[x]

Differential View

This structure is derived from GuidanceResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse GuidanceResponse
... Slices for module[x] 1..1 uri, canonical(), CodeableConcept What guidance was requested
Slice: Unordered, Open by type:$this
.... module[x]:moduleUri 0..1 uri What guidance was requested
Required Pattern: /antimicroGuidanceRequest
... reasonCode
.... coding S 1..1 Coding Code defined by a terminology system
..... system 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
... evaluationMessage 0..* Reference(Antimicrobial Operation Outcome) Messages resulting from the evaluation of the artifact or artifacts

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse 0..* GuidanceResponse The formal response to a guidance request
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for module[x] Σ 1..1 What guidance was requested
Slice: Unordered, Open by type:$this
.... moduleUri uri
.... moduleCanonical canonical(Any)
.... moduleCodeableConcept CodeableConcept
.... module[x]:moduleUri Σ 0..1 uri What guidance was requested
Required Pattern: /antimicroGuidanceRequest
... reasonCode 0..* CodeableConcept Why guidance is needed
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
... evaluationMessage 0..* Reference(Antimicrobial Operation Outcome) Messages resulting from the evaluation of the artifact or artifacts
... outputParameters 0..1 Reference(Antimicrobial Parameters) The output parameters of the evaluation, if any

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GuidanceResponse.statusrequiredGuidanceResponseStatus
http://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGuidanceResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGuidanceResponseIf 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-4errorGuidanceResponseIf 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-5errorGuidanceResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGuidanceResponseA 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. GuidanceResponse 0..* GuidanceResponse The formal response to a guidance request
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... requestIdentifier Σ 0..1 Identifier The identifier of the request associated with this response, if any
... identifier Σ 0..* Identifier Business identifier
... Slices for module[x] Σ 1..1 What guidance was requested
Slice: Unordered, Open by type:$this
.... moduleUri uri
.... moduleCanonical canonical(Any)
.... moduleCodeableConcept CodeableConcept
.... module[x]:moduleUri Σ 0..1 uri What guidance was requested
Required Pattern: /antimicroGuidanceRequest
... status ?!Σ 1..1 code success | data-requested | data-required | in-progress | failure | entered-in-error
Binding: GuidanceResponseStatus (required): The status of a guidance response.

... subject 0..1 Reference(Patient | Group) Patient the request was performed for
... encounter 0..1 Reference(Encounter) Encounter during which the response was returned
... occurrenceDateTime 0..1 dateTime When the guidance response was processed
... performer 0..1 Reference(Device) Device returning the guidance
... reasonCode 0..* CodeableConcept Why guidance is needed
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why guidance is needed
... note 0..* Annotation Additional notes about the response
... evaluationMessage 0..* Reference(Antimicrobial Operation Outcome) Messages resulting from the evaluation of the artifact or artifacts
... outputParameters 0..1 Reference(Antimicrobial Parameters) The output parameters of the evaluation, if any
... result 0..1 Reference(CarePlan | RequestGroup) Proposed actions, if any
... dataRequirement 0..* DataRequirement Additional required data

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
GuidanceResponse.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
GuidanceResponse.statusrequiredGuidanceResponseStatus
http://hl7.org/fhir/ValueSet/guidance-response-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGuidanceResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGuidanceResponseIf 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-4errorGuidanceResponseIf 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-5errorGuidanceResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGuidanceResponseA 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()

This structure is derived from GuidanceResponse

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 1 element
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of GuidanceResponse.module[x]

 

Other representations of profile: CSV, Excel, Schematron