Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Paymentnotice.shex

Financial Management Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Practitioner

Raw ShEx

ShEx statement for paymentnotice

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 <date.shex>
IMPORT <Money.shex>
IMPORT <Resource.shex>
IMPORT <dateTime.shex>
IMPORT <Reference.shex>
IMPORT <Identifier.shex>
IMPORT <Organization.shex>
IMPORT <Practitioner.shex>
IMPORT <DomainResource.shex>
IMPORT <CodeableConcept.shex>
IMPORT <PractitionerRole.shex>
IMPORT <PaymentReconciliation.shex>


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

# PaymentNotice request
<PaymentNotice> EXTENDS @<DomainResource> CLOSED {   

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

    fhir:identifier @<OneOrMore_Identifier>?;  # Business Identifier for the 
                                            # payment notice 
    fhir:status @<code> AND
    	{fhir:v @fhirvs:fm-status};  # active | cancelled | draft | 
                                            # entered-in-error 
    fhir:request @<Reference> AND {fhir:link 
    			@<Resource> ? }?;  # Request reference
    fhir:response @<Reference> AND {fhir:link 
    			@<Resource> ? }?;  # Response reference
    fhir:created @<dateTime>;               # Creation date
    fhir:reporter @<Reference> AND {fhir:link 
    			@<Organization> OR 
    			@<Practitioner> OR 
    			@<PractitionerRole> ? }?;  # Responsible practitioner
    fhir:payment @<Reference> AND {fhir:link 
    			@<PaymentReconciliation> ? }?;  # Payment reference
    fhir:paymentDate @<date>?;              # Payment or clearing date
    fhir:payee @<Reference> AND {fhir:link 
    			@<Organization> OR 
    			@<Practitioner> OR 
    			@<PractitionerRole> ? }?;  # Party being paid
    fhir:recipient @<Reference> AND {fhir:link 
    			@<Organization> ? };  # Party being notified
    fhir:amount @<Money>;                   # Monetary amount of the payment
    fhir:paymentStatus @<CodeableConcept>?;  # Issued or cleared Status of the 
                                            # payment 
}  

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

<OneOrMore_Identifier> CLOSED {
    rdf:first @<Identifier>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Identifier> 
}

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

# This value set includes Status codes.
fhirvs:fm-status ["active" "cancelled" "draft" "entered-in-error"]


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.