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

Person.shex

Patient Administration Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Patient, Practitioner, RelatedPerson

Raw ShEx

ShEx statement for person

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 <boolean.shex>
IMPORT <Address.shex>
IMPORT <Patient.shex>
IMPORT <dateTime.shex>
IMPORT <HumanName.shex>
IMPORT <Reference.shex>
IMPORT <Identifier.shex>
IMPORT <Attachment.shex>
IMPORT <ContactPoint.shex>
IMPORT <Organization.shex>
IMPORT <Practitioner.shex>
IMPORT <DomainResource.shex>
IMPORT <CodeableConcept.shex>
IMPORT <BackboneElement.shex>


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

# A generic person record
<Person> EXTENDS @<DomainResource> CLOSED {   

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

    fhir:identifier @<OneOrMore_Identifier>?;  # A human identifier for this person
    fhir:active @<boolean>?;                # This person's record is in active 
                                            # use 
    fhir:name @<OneOrMore_HumanName>?;      # A name associated with the person
    fhir:telecom @<OneOrMore_ContactPoint>?;  # A contact detail for the person
    fhir:gender @<code> AND
    	{fhir:v @fhirvs:administrative-gender}?;  # male | female | other | unknown
    fhir:birthDate @<date>?;                # The date on which the person was 
                                            # born 
    fhir:deceased @<boolean>  OR 
    			@<dateTime>  ?;  # Indicates if the individual is 
                                            # deceased or not 
    fhir:address @<OneOrMore_Address>?;     # One or more addresses for the 
                                            # person 
    fhir:maritalStatus @<CodeableConcept>?;  # Marital (civil) status of a person
    fhir:photo @<OneOrMore_Attachment>?;    # Image of the person
    fhir:communication @<OneOrMore_Person.communication>?;  # A language which may be used to 
                                            # communicate with the person about 
                                            # his or her health 
    fhir:managingOrganization @<Reference> AND {fhir:link 
    			@<Organization> ? }?;  # The organization that is the 
                                            # custodian of the person record 
    fhir:link @<OneOrMore_Person.link>?;    # Link to a resource that concerns 
                                            # the same actual person 
}  

# Link to a resource that concerns the same actual person
<Person.link> EXTENDS @<BackboneElement> CLOSED {   
    fhir:target @<Reference> AND {fhir:link 
    			@<Patient> OR 
    			@<Person> OR 
    			@<Practitioner> OR 
    			@<RelatedPerson> ? };  # The resource to which this actual 
                                            # person is associated 
    fhir:assurance @<code> AND
    	{fhir:v @fhirvs:identity-assuranceLevel}?;  # level1 | level2 | level3 | level4
}  

# A language which may be used to communicate with the person about his or her health
<Person.communication> EXTENDS @<BackboneElement> CLOSED {   
    fhir:language @<CodeableConcept>;       # The language which can be used to 
                                            # communicate with the person about 
                                            # his or her health 
    fhir:preferred @<boolean>?;             # Language preference indicator
}  

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

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

<OneOrMore_HumanName> CLOSED {
    rdf:first @<HumanName>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_HumanName> 
}

<OneOrMore_ContactPoint> CLOSED {
    rdf:first @<ContactPoint>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_ContactPoint> 
}

<OneOrMore_Address> CLOSED {
    rdf:first @<Address>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Address> 
}

<OneOrMore_Attachment> CLOSED {
    rdf:first @<Attachment>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Attachment> 
}

<OneOrMore_Person.communication> CLOSED {
    rdf:first @<Person.communication>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Person.communication> 
}

<OneOrMore_Person.link> CLOSED {
    rdf:first @<Person.link>  ;
    rdf:rest [rdf:nil] OR @<OneOrMore_Person.link> 
}

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

# The gender of a person used for administrative purposes.
fhirvs:administrative-gender ["male" "female" "other" "unknown"]

# The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.
fhirvs:identity-assuranceLevel ["level1" "level2" "level3" "level4"]


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.