Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension-humanname-partner-name.json

Example Endpoint/example-iid (XML)

FHIR Infrastructure Patient Administration Work Group Maturity Level : N/A Standards Status : Informative Compartments : Not linked to any defined compartments

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

Jump past Narrative

partner-name Example of IHE-IID endpoint (id = "example-iid")

{ "resourceType" : "StructureDefinition", "id" : "humanname-partner-name", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode" : "fhir" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger" : 1 }], "url" : "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "version" : "4.0.1", "name" : "partner-name", "status" : "draft", "date" : "2015-11-22", "publisher" : "Health Level Seven, Inc. - FHIR Core WG", "contact" : [{ "telecom" : [{ "system" : "url", "value" : "http://hl7.org/special/committees/FHIR" }] }], "description" : "The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name.", "fhirVersion" : "4.0.1", "mapping" : [{ "identity" : "v2", "uri" : "http://hl7.org/v2", "name" : "HL7 v2 Mapping" }, { "identity" : "rim", "uri" : "http://hl7.org/v3", "name" : "RIM Mapping" }], "kind" : "complex-type", "abstract" : false, "context" : [{ "type" : "element", "expression" : "HumanName.family" }], "type" : "Extension", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension", "derivation" : "constraint", "snapshot" : { "element" : [{ "id" : "Extension", "path" : "Extension", "short" : "Portion derived from person's partner's surname", "definition" : "The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name.", "comment" : "If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's \"maiden name\".", "min" : 0, "max" : "1", "base" : { "path" : "Extension", "min" : 0, "max" : "*" }, "condition" : ["ele-1"], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "mapping" : [{ "identity" : "v2", "map" : "FN.5" }, { "identity" : "rim", "map" : "ENXP where Qualifiers = (SP)" }] }, { "id" : "Extension.id", "path" : "Extension.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Extension.extension", "path" : "Extension.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Extension", "definition" : "An Extension", "min" : 0, "max" : "0", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Extension.url", "path" : "Extension.url", "representation" : ["xmlAttr"], "short" : "identifies the meaning of the extension", "definition" : "Source of the definition for the extension code - a logical name or a URL.", "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min" : 1, "max" : "1", "base" : { "path" : "Extension.url", "min" : 1, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "uri" }], "code" : "http://hl7.org/fhirpath/System.String" }], "fixedUri" : "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Extension.value[x]", "path" : "Extension.value[x]", "short" : "Value of extension", "definition" : "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list).", "min" : 1, "max" : "1", "base" : { "path" : "Extension.value[x]", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }] }, "differential" : { "element" : [{ "id" : "Extension", "path" : "Extension", "short" : "Portion derived from person's partner's surname", "definition" : "The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name.", "comment" : "If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's \"maiden name\".", "min" : 0, "max" : "1", "mapping" : [{ "identity" : "v2", "map" : "FN.5" }, { "identity" : "rim", "map" : "ENXP where Qualifiers = (SP)" }] }, { "id" : "Extension.extension", "path" : "Extension.extension", "max" : "0" }, { "id" : "Extension.url", "path" : "Extension.url", "fixedUri" : "http://hl7.org/fhir/StructureDefinition/humanname-partner-name" }, { "id" : "Extension.value[x]", "path" : "Extension.value[x]", "min" : 1, "type" : [{ "code" : "string" }] }] } } 
<?xml version="1.0" encoding="UTF-8"?>

<Endpoint xmlns="http://hl7.org/fhir">
  <id value="example-iid"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">

      Example of an Imaging IID type endpoint
    </div> 
  </text> 

    
  <status value="active"/> 
  <connectionType> 
    <coding> 
      <system value="http://terminology.hl7.org/CodeSystem/endpoint-connection-type"/> 
      <code value="ihe-iid"/> 
    </coding> 
  </connectionType> 
  <name value="PACS Hospital Invoke Image Display endpoint"/> 
  <payloadType> 
    <text value="DICOM IID"/> 
  </payloadType> 


  <address value="https://pacs.hospital.org/IHEInvokeImageDisplay"/>  

</

Endpoint

>

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.