Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Operationoutcome.shex

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: No defined compartments

Raw ShEx

ShEx statement for operationoutcome

PREFIX fhir: <http://hl7.org/fhir/> 
PREFIX fhirvs: <http://hl7.org/fhir/ValueSet/>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#> 
PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> 

IMPORT <code.shex>
IMPORT <string.shex>
IMPORT <DomainResource.shex>
IMPORT <BackboneElement.shex>
IMPORT <CodeableConcept.shex>


start=@<OperationOutcome> AND {fhir:nodeRole [fhir:treeRoot]}

# Information about the success/failure of an action
<OperationOutcome> EXTENDS @<DomainResource> CLOSED {   

    a [fhir:OperationOutcome]?;
    fhir:nodeRole [fhir:treeRoot]?;

    fhir:issue @<OneOrMore_OperationOutcome.issue>;  # A single issue associated with the 
                                            # action 
}  

# A single issue associated with the action
<OperationOutcome.issue> EXTENDS @<BackboneElement> CLOSED {   
    fhir:severity @<code> AND
    	{fhir:v @fhirvs:issue-severity};  # fatal | error | warning | 
                                            # information | success 
    fhir:code @<code> AND
    	{fhir:v @fhirvs:issue-type};  # Error or warning code
    fhir:details @<CodeableConcept>?;       # Additional details about the error
    fhir:diagnostics @<string>?;            # Additional diagnostic information 
                                            # about the issue 
    fhir:location @<OneOrMore_string>?;     # Deprecated: Path of element(s) 
                                            # related to issue 
    fhir:expression @<OneOrMore_string>?;   # FHIRPath of element(s) related to 
                                            # issue 
}  

#---------------------- Cardinality Types (OneOrMore) -------------------

<OneOrMore_OperationOutcome.issue> CLOSED {
    rdf:first @<OperationOutcome.issue>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_OperationOutcome.issue> 
}

<OneOrMore_string> CLOSED {
    rdf:first @<string>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_string> 
}

#---------------------- Value Sets ------------------------

# How the issue affects the success of the action.
fhirvs:issue-severity ["fatal" "error" "warning" "information" "success"]

# A code that describes the type of issue.
fhirvs:issue-type ["invalid" "structure" "required" "value" "invariant" "security" "login" "unknown" "expired" "forbidden" "suppressed" "processing" "not-supported" "duplicate" "multiple-matches" "not-found" "deleted" "too-long" "code-invalid" "extension" "too-costly" "business-rule" "conflict" "limited-filter" "transient" "lock-error" "no-store" "exception" "timeout" "incomplete" "throttled" "informational" "success"]


Usage note: every effort has been made to ensure that the ShEx files are correct and useful, but they are not a normative part of the specification.