Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Example StructureDefinition/ParticipantLiving (XML)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

Logical Model ParticipantLiving

<?xml version="1.0" encoding="UTF-8"?>

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="ParticipantLiving"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">to do</div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="informative"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/ParticipantLiving"/> 
  <version value="5.0.0-ballot"/> 
  <name value="ParticipantLiving"/> 
  <title value="participantliving"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2022-09-10T04:52:37+10:00"/> 
  <publisher value="Health Level Seven International fhir"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="Logical Model: A pattern followed by resources that represent the participant in
   some activity, process, or responsible for providing information about a resource."/> 
  <fhirVersion value="5.0.0-ballot"/> 
  <mapping> 
    <identity value="rim"/> 
    <uri value="http://hl7.org/v3"/> 
    <name value="RIM Mapping"/> 
  </mapping> 
  <kind value="logical"/> 
  <abstract value="false"/> 
  <type value="ParticipantLiving"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/> 
  <snapshot> 
    <element id="ParticipantLiving">
      <path value="ParticipantLiving"/> 
      <short value="Participant Pattern"/> 
      <definition value="A pattern followed by resources that represent the participant in some activity,
       process, or responsible for providing information about a resource."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="ParticipantLiving"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="Role"/> 
      </mapping> 
    </element> 
    <element id="ParticipantLiving.birthDate">
      <path value="ParticipantLiving.birthDate"/> 
      <short value="The date of birth for the individual"/> 
      <definition value="The date of birth for the individual."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="ParticipantLiving.birthDate"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="date"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="ParticipantLiving.gender">
      <path value="ParticipantLiving.gender"/> 
      <short value="male | female | other | unknown"/> 
      <definition value="Administrative Gender - the gender that the participant is considered to have for
       administration and record keeping purposes."/> 
      <requirements value="Needed for identification of the individual, in combination with (at least) name
       and birth date."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="ParticipantLiving.gender"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="code"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <binding> 
        <extension url="http://hl7.org/fhir/build/StructureDefinition/binding-definition">
          <valueString value="The gender of a person used for administrative purposes."/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="AdministrativeGender"/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
          <valueBoolean value="true"/> 
        </extension> 
        <strength value="required"/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0-ballot"/> 
      </binding> 
    </element> 
    <element id="ParticipantLiving.photo">
      <path value="ParticipantLiving.photo"/> 
      <short value="Image of the participant"/> 
      <definition value="Image of the participant."/> 
      <requirements value="Many EHR systems have the capability to capture an image of the participant. Fits
       with newer social media usage too."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="ParticipantLiving.photo"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Attachment"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="ParticipantLiving.communication">
      <path value="ParticipantLiving.communication"/> 
      <short value="The language which can be used to communicate with the participant"/> 
      <definition value="The ISO-639-1 alpha 2 code in lower case for the language, optionally followed
       by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g.
       &quot;en&quot; for English, or &quot;en-US&quot; for American English versus &quot;en-AU&quot
      ; for Australian English."/> 
      <requirements value="Most systems in multilingual countries will want to convey language. Not all systems
       actually need the regional dialect."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="ParticipantLiving.communication"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <binding> 
        <extension url="http://hl7.org/fhir/build/StructureDefinition/binding-definition">
          <valueString value="A human language."/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
          <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages"/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="Language"/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
          <valueBoolean value="true"/> 
        </extension> 
        <strength value="preferred"/> 
        <description value="IETF language tag"/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/languages"/> 
      </binding> 
    </element> 
  </snapshot> 
</StructureDefinition> 

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