HL7 FHIR® US Core Implementation Guide STU3 Release 3.1.1

This page is part of the US Core (v3.1.1: STU3) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

JSON Format: SearchParameter-us-core-patient-family

Download Raw json 

{
  "resourceType" : "SearchParameter",
  "id" : "us-core-patient-family",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>SearchParameter: USCorePatientFamily</h2><p><b> description</b> : A portion of the family name of the patient<br/>\n<em>NOTE</em>: This US Core SearchParameter definition extends the usage context of\n<a href=\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\">capabilitystatement-expectation</a>\n extension to formally express implementer conformance expectations for these elements:<br/>\n - multipleAnd<br/>\n - multipleOr<br/>\n - comparator<br/>\n - modifier<br/>\n - chain<br/>\n\n </p><br/><p><b> id</b> us-core-patient-family</p><p><b> url</b> : <b> http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family</b>\n\t\t\t</p><p><b> version</b> : 4.0.1</p><p><b> name</b> : USCorePatientFamily</p><p><b> derivedFrom</b> : http://hl7.org/fhir/SearchParameter/individual-family\n\t\t\t</p><p><b> status</b> : active</p><p><b> experimental</b>  False</p><p><b> date</b> : 2020-07-01</p><p><b> publisher</b> : HL7 International - US Realm Steering Committee</p><p><b> contact</b> : http://www.hl7.org/Special/committees/usrealm/index.cfm</p><p><b> useContext</b> : </p><p><b> jurisdiction</b> : United States of America (the) <span> (Details : {urn:iso:std:iso:3166 code 'US' = 'United States of America', given as 'United\n           States of America (the)'})</span>\n\t\t\t</p>  <!-- <p>\n\t\t<b> purpose</b> : Need to search by identifier for various infrastructural cases - mainly retrieving packages,\n         and matching as part of a chain</p> --><p><b> code</b> : <code>family</code>\n\t\t\t</p><p><b> base</b> :Patient</p><p><b> type</b> : string</p><p><b> expression</b> : <code>Patient.name.family</code>\n\t\t\t</p><p><b> xpath</b> : <code>f:Patient/f:name/f:family</code>\n\t\t\t</p><p><b> xpathUsage</b> : normal</p><p><b> mulitpleOr</b> : True   (Conformance Expectation = MAY)</p><p><b> mulitpleAnd</b> : True  ( Conformance Expectation = MAY)</p></div>"
  },
  "url" : "http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family",
  "version" : "3.1.1",
  "name" : "USCorePatientFamily",
  "derivedFrom" : "http://hl7.org/fhir/SearchParameter/individual-family",
  "status" : "active",
  "experimental" : false,
  "date" : "2020-07-01T21:51:57.548525Z",
  "publisher" : "HL7 International - US Realm Steering Committee",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/usrealm/index.cfm"
        }
      ]
    }
  ],
  "description" : "A portion of the family name of the patient<br />\n<em>NOTE</em>: This US Core SearchParameter definition extends the usage context of\n<a href=\"http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html\">capabilitystatement-expectation</a>\n extension to formally express implementer conformance expectations for these elements:<br />\n - multipleAnd<br />\n - multipleOr<br />\n - comparator<br />\n - modifier<br />\n - chain<br />\n\n ",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "code" : "family",
  "base" : [
    "Patient"
  ],
  "type" : "string",
  "expression" : "Patient.name.family",
  "xpath" : "f:Patient/f:name/f:family",
  "xpathUsage" : "normal",
  "multipleOr" : true,
  "_multipleOr" : {
    "extension" : [
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode" : "MAY"
      }
    ]
  },
  "multipleAnd" : true,
  "_multipleAnd" : {
    "extension" : [
      {
        "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode" : "MAY"
      }
    ]
  }
}