HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/core/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: PT_OperationOutcome

A generic OperationOutcome resource for Portugal

Usage:

• Refer to this Resource Profile: PT_MessageHeader

Formal Views of Profile Content

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

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

This structure is derived from OperationOutcome

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome			OperationOutcome
issue
severity		1..1	code	fatal | error | warning | information
code		1..1	code	Error or warning code
details
coding
system		0..1	uri	Identity of the terminology system
code		0..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
text		0..1	string	Plain text representation of the concept
diagnostics		0..1	string	Additional diagnostic information about the issue
Documentation for this format

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	Σ	1..*	BackboneElement	A single issue associated with the action
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
severity	Σ	1..1	code	fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code	Σ	1..1	code	Error or warning code Binding: IssueType (required): A code that describes the type of issue.
diagnostics	Σ	0..1	string	Additional diagnostic information about the issue
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
OperationOutcome.issue.severity	required	IssueSeverity http://hl7.org/fhir/ValueSet/issue-severity|4.0.1 from the FHIR Standard
OperationOutcome.issue.code	required	IssueType http://hl7.org/fhir/ValueSet/issue-type|4.0.1 from the FHIR Standard

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	Σ	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	Σ	1..1	code	fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code	Σ	1..1	code	Error or warning code Binding: IssueType (required): A code that describes the type of issue.
details	Σ	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	Σ	0..*	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
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
diagnostics	Σ	0..1	string	Additional diagnostic information about the issue
location	Σ	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	URI
OperationOutcome.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
OperationOutcome.issue.severity	required	IssueSeverity http://hl7.org/fhir/ValueSet/issue-severity|4.0.1 from the FHIR Standard
OperationOutcome.issue.code	required	IssueType http://hl7.org/fhir/ValueSet/issue-type|4.0.1 from the FHIR Standard
OperationOutcome.issue.details	example	OperationOutcomeCodes http://hl7.org/fhir/ValueSet/operation-outcome from the FHIR Standard

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()

This structure is derived from OperationOutcome

Summary

Differential View

This structure is derived from OperationOutcome

Name	Flags	Card.	Type	Description & Constraints
OperationOutcome			OperationOutcome
issue
severity		1..1	code	fatal | error | warning | information
code		1..1	code	Error or warning code
details
coding
system		0..1	uri	Identity of the terminology system
code		0..1	code	Symbol in syntax defined by the system
display		0..1	string	Representation defined by the system
text		0..1	string	Plain text representation of the concept
diagnostics		0..1	string	Additional diagnostic information about the issue
Documentation for this format

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	Σ	1..*	BackboneElement	A single issue associated with the action
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
severity	Σ	1..1	code	fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code	Σ	1..1	code	Error or warning code Binding: IssueType (required): A code that describes the type of issue.
diagnostics	Σ	0..1	string	Additional diagnostic information about the issue
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
OperationOutcome.issue.severity	required	IssueSeverity http://hl7.org/fhir/ValueSet/issue-severity|4.0.1 from the FHIR Standard
OperationOutcome.issue.code	required	IssueType http://hl7.org/fhir/ValueSet/issue-type|4.0.1 from the FHIR Standard

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	Σ	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	Σ	1..1	code	fatal | error | warning | information Binding: IssueSeverity (required): How the issue affects the success of the action.
code	Σ	1..1	code	Error or warning code Binding: IssueType (required): A code that describes the type of issue.
details	Σ	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	Σ	0..*	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
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
diagnostics	Σ	0..1	string	Additional diagnostic information about the issue
location	Σ	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	URI
OperationOutcome.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
OperationOutcome.issue.severity	required	IssueSeverity http://hl7.org/fhir/ValueSet/issue-severity|4.0.1 from the FHIR Standard
OperationOutcome.issue.code	required	IssueType http://hl7.org/fhir/ValueSet/issue-type|4.0.1 from the FHIR Standard
OperationOutcome.issue.details	example	OperationOutcomeCodes http://hl7.org/fhir/ValueSet/operation-outcome from the FHIR Standard

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()

This structure is derived from OperationOutcome

Summary

Other representations of profile: CSV, Excel, Schematron