FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Example StructureDefinition/ParticipantLiving (JSON)

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

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

Logical Model ParticipantLiving

{
  "resourceType" : "StructureDefinition",
  "id" : "ParticipantLiving",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">to do</div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "informative"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  }],
  "url" : "http://hl7.org/fhir/StructureDefinition/ParticipantLiving",
  "version" : "6.0.0-cibuild",
  "name" : "ParticipantLiving",
  "title" : "participantliving",
  "status" : "draft",
  "experimental" : false,
  "date" : "2024-06-17T18:39:48+00:00",
  "publisher" : "HL7 International / FHIR Infrastructure",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  },
  {
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/fiwg"
    }]
  }],
  "description" : "Logical Model: A pattern followed by resources that represent the participant in some activity, process, or responsible for providing information about a resource.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "fhirVersion" : "6.0.0-cibuild",
  "mapping" : [{
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  }],
  "kind" : "logical",
  "abstract" : false,
  "type" : "ParticipantLiving",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
  "snapshot" : {
    "element" : [{
      "id" : "ParticipantLiving",
      "path" : "ParticipantLiving",
      "short" : "Participant Pattern",
      "definition" : "A pattern followed by resources that represent the participant in some activity, process, or responsible for providing information about a resource.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "ParticipantLiving",
        "min" : 0,
        "max" : "*"
      },
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "Role"
      }]
    },
    {
      "id" : "ParticipantLiving.birthDate",
      "path" : "ParticipantLiving.birthDate",
      "short" : "The date of birth for the {{title}}",
      "definition" : "The date when the {{title}} was born.",
      "requirements" : "Used for identity verification and may drive other business processes.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "ParticipantLiving.birthDate",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "date"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : false
    },
    {
      "id" : "ParticipantLiving.gender",
      "path" : "ParticipantLiving.gender",
      "short" : "male | female | other | unknown",
      "definition" : "Administrative Gender - the gender that the {{title}} is considered to have for administration and record keeping purposes.",
      "requirements" : "Needed for identification of the individual, in combination with (at least) name and birth date.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "ParticipantLiving.gender",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "code"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
          "valueMarkdown" : "The gender of a person used for administrative purposes."
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "AdministrativeGender"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
          "valueBoolean" : true
        }],
        "strength" : "required",
        "description" : "The gender of a person used for administrative purposes.",
        "valueSet" : "http://hl7.org/fhir/ValueSet/administrative-gender|6.0.0-cibuild"
      }
    },
    {
      "id" : "ParticipantLiving.photo",
      "path" : "ParticipantLiving.photo",
      "short" : "Image of the {{title}",
      "definition" : "A facial image of the {{title}}.",
      "requirements" : "Many EHR systems have the capability to capture an image of the participant. Fits with newer social media usage too.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "ParticipantLiving.photo",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "Attachment"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : false
    },
    {
      "id" : "ParticipantLiving.communication",
      "path" : "ParticipantLiving.communication",
      "short" : "Language used by {{title}}",
      "definition" : "The language which can be used to communicate with the {{title}}.",
      "comment" : "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. \"en\" for English, or \"en-US\" for American English versus \"en-AU\" for Australian English.",
      "requirements" : "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "ParticipantLiving.communication",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "binding" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
          "valueMarkdown" : "IETF language tag for a human language."
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
          "valueString" : "Language"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
          "valueBoolean" : true
        }],
        "strength" : "required",
        "description" : "IETF language tag for a human language.",
        "valueSet" : "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-cibuild",
        "additional" : [{
          "purpose" : "starter",
          "valueSet" : "http://hl7.org/fhir/ValueSet/languages"
        }]
      }
    }]
  }
}

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.