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/Participant (XML)

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

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

Logical Model Participant

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

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Participant"/> 
  <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/Participant"/> 
  <version value="5.0.0-ballot"/> 
  <name value="Participant"/> 
  <title value="participant"/> 
  <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="Participant"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/> 
  <snapshot> 
    <element id="Participant">
      <path value="Participant"/> 
      <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="Participant"/> 
        <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="Participant.identifier">
      <path value="Participant.identifier"/> 
      <short value="Business Identifier for participant"/> 
      <definition value="Business identifiers assigned to this participant by one of the applications involved.
        These identifiers remain constant as the resource is updated and propagates from
       server to server."/> 
      <comment value="Note: This is a business identifier, not a resource identifier (see [discussion](resource.htm
      l#identifiers)).  It is best practice for the identifier to only appear on a single
       resource instance, however business practices may occasionally dictate that multiple
       resource instances with the same identifier can exist - possibly even with different
       resource types.  For example, multiple Patient and a Person resource instance might
       share the same social insurance number."/> 
      <requirements value="Allows identification of the participant as it is known by various participating
       systems and in a way that remains consistent across servers."/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Participant.identifier"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Identifier"/> 
      </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="true"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".identifier"/> 
      </mapping> 
    </element> 
    <element id="Participant.active">
      <path value="Participant.active"/> 
      <short value="Whether the participant is currently active"/> 
      <definition value="Whether this participant record is in active use."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Participant.active"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="boolean"/> 
      </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="true"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".status"/> 
      </mapping> 
    </element> 
    <element id="Participant.name">
      <path value="Participant.name"/> 
      <short value="A name for the participant"/> 
      <definition value="Description of participant as presented to a consumer while searching."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Participant.name"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="string"/> 
      </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="true"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value=".name"/> 
      </mapping> 
    </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.