Scope and usage

This profile is called MedComAcknowledgementOperationOutcome and is used to give a detailed describtion of errors occuring when exchanging FHIR messages. Succes or fail in message exchange can be found in the element MessageHeader.response.code. MedComAcknowledgementOperationOutcome can be seen as a help for IT-vendors to identify potential errors in their systems, as it least shall contain a description of the issue, including a severity and an error or warning code. It may include several issues.

Please refer to the tab “Snapshot Table(Must support)” below for the definition of the required content of a MedComAcknowledgementMessage.

When to include an OperationOutcome

MedComAcknowledgementOperationOutcome should not be included when the message exchange goes well, corresponding to the value ‘ok’ in MessageHeader.response.code. However, may be included when the MessageHeader.response.code is ‘ok’, e.g. in cases where the received message is valid, but it is a dublet of a previous sent message. In this case an OperationOutcome with a value of OperationOutcome.issue.severity ‘information’ and a relevant code could be included. An OperationOutcome resource shall be included when the element MessageHeader.response.code is different from ‘ok’.

OperationOutCome.issue.details.coding

The CodeSystem MedComAcknowledgementIssueDetailsand ValueSetMedComAcknowledgementIssueDetailValues used in the element OperationOutCome.issue.details.coding are used to describe the issue of receiving a message more detailed. Currently, the two terminologies are fairly empty, as MedCom wants input from IT-vendors on which issue codes provide value in IT-systems. Across sectors there must be an agreed list of codes. Therefore, the ValueSet has a status as ‘draft’ and vendors should expect the CodeSystem and ValueSet to be extended. For relevant input regarding the issue codes, please contact MedCom.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from OperationOutcome

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome		0..*	OperationOutcome	Information about the success/failure of an action
issue	S	1..*	BackboneElement	A single issue associated with the action
severity	S	1..1	code	fatal | error | warning | information
code	S	1..1	code	Error or warning code
details	S	0..1	CodeableConcept	Additional details about the error
coding	S	0..*	Coding	Code defined by a terminology system Binding: MedComAcknowledgementIssueDetailValues (required)
text	S	0..1	string	Plain text representation of the concept
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
OperationOutcome.issue.details.coding	required	MedComAcknowledgementIssueDetailValues

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome		0..*	OperationOutcome	Information about the success/failure of an action
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
issue	SΣ	1..*	BackboneElement	A single issue associated with the action
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
severity	SΣ	1..1	code	fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code	SΣ	1..1	code	Error or warning code Binding: IssueType (required): A code that describes the type of issue.
details	SΣ	0..1	CodeableConcept	Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
coding	SΣ	0..*	Coding	Code defined by a terminology system Binding: MedComAcknowledgementIssueDetailValues (required)
text	SΣ	0..1	string	Plain text representation of the concept
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
OperationOutcome.issue.severity	required	IssueSeverity
OperationOutcome.issue.code	required	IssueType
OperationOutcome.issue.details	example	OperationOutcomeCodes
OperationOutcome.issue.details.coding	required	MedComAcknowledgementIssueDetailValues

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	OperationOutcome	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	OperationOutcome	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	OperationOutcome	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	OperationOutcome	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	OperationOutcome	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()

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome		0..*	OperationOutcome	Information about the success/failure of an action
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. Additional Bindings Purpose AllLanguages Max Binding
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
issue	SΣ	1..*	BackboneElement	A single issue associated with the action
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
severity	SΣ	1..1	code	fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code	SΣ	1..1	code	Error or warning code Binding: IssueType (required): A code that describes the type of issue.
details	SΣ	0..1	CodeableConcept	Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
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Σ	0..*	Coding	Code defined by a terminology system Binding: MedComAcknowledgementIssueDetailValues (required)
text	SΣ	0..1	string	Plain text representation of the concept
diagnostics	Σ	0..1	string	Additional diagnostic information about the issue
location	ΣXD	0..*	string	Deprecated: Path of element(s) related to issue
expression	Σ	0..*	string	FHIRPath of element(s) related to issue
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
OperationOutcome.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
OperationOutcome.issue.severity	required	IssueSeverity
OperationOutcome.issue.code	required	IssueType
OperationOutcome.issue.details	example	OperationOutcomeCodes
OperationOutcome.issue.details.coding	required	MedComAcknowledgementIssueDetailValues

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Differential View

This structure is derived from OperationOutcome

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome		0..*	OperationOutcome	Information about the success/failure of an action
issue	S	1..*	BackboneElement	A single issue associated with the action
severity	S	1..1	code	fatal | error | warning | information
code	S	1..1	code	Error or warning code
details	S	0..1	CodeableConcept	Additional details about the error
coding	S	0..*	Coding	Code defined by a terminology system Binding: MedComAcknowledgementIssueDetailValues (required)
text	S	0..1	string	Plain text representation of the concept
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
OperationOutcome.issue.details.coding	required	MedComAcknowledgementIssueDetailValues

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome		0..*	OperationOutcome	Information about the success/failure of an action
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
issue	SΣ	1..*	BackboneElement	A single issue associated with the action
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
severity	SΣ	1..1	code	fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code	SΣ	1..1	code	Error or warning code Binding: IssueType (required): A code that describes the type of issue.
details	SΣ	0..1	CodeableConcept	Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
coding	SΣ	0..*	Coding	Code defined by a terminology system Binding: MedComAcknowledgementIssueDetailValues (required)
text	SΣ	0..1	string	Plain text representation of the concept
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
OperationOutcome.issue.severity	required	IssueSeverity
OperationOutcome.issue.code	required	IssueType
OperationOutcome.issue.details	example	OperationOutcomeCodes
OperationOutcome.issue.details.coding	required	MedComAcknowledgementIssueDetailValues

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	OperationOutcome	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	OperationOutcome	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	OperationOutcome	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	OperationOutcome	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	OperationOutcome	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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome		0..*	OperationOutcome	Information about the success/failure of an action
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. Additional Bindings Purpose AllLanguages Max Binding
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
issue	SΣ	1..*	BackboneElement	A single issue associated with the action
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
severity	SΣ	1..1	code	fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code	SΣ	1..1	code	Error or warning code Binding: IssueType (required): A code that describes the type of issue.
details	SΣ	0..1	CodeableConcept	Additional details about the error Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
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Σ	0..*	Coding	Code defined by a terminology system Binding: MedComAcknowledgementIssueDetailValues (required)
text	SΣ	0..1	string	Plain text representation of the concept
diagnostics	Σ	0..1	string	Additional diagnostic information about the issue
location	ΣXD	0..*	string	Deprecated: Path of element(s) related to issue
expression	Σ	0..*	string	FHIRPath of element(s) related to issue
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
OperationOutcome.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
OperationOutcome.issue.severity	required	IssueSeverity
OperationOutcome.issue.code	required	IssueType
OperationOutcome.issue.details	example	OperationOutcomeCodes
OperationOutcome.issue.details.coding	required	MedComAcknowledgementIssueDetailValues

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from OperationOutcome

Summary

Must-Support: 6 elements