This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| Modeling and Methodology Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for ExtendedContactDetail
{
"resourceType" : "StructureDefinition",
"id" : "ExtendedContactDetail",
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/ExtendedContactDetail",
"version" : "5.0.0-ballot",
"name" : "ExtendedContactDetail",
"status" : "draft",
"experimental" : false,
"date" : "2022-09-07T10:58:29+10:00",
"publisher" : "HL7 FHIR Standard",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "ExtendedContactDetail Type: Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.",
"purpose" : "Need to track contact and address information in the same way across multiple resources.",
"fhirVersion" : "5.0.0-ballot",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}],
"kind" : "complex-type",
"abstract" : false,
"type" : "ExtendedContactDetail",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DataType",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "ExtendedContactDetail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "ExtendedContactDetail",
"short" : "Contact information",
"definition" : "Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.",
"comment" : "This datatype may be sparsely populated, i.e. only contain a purpose and phone number or address, but other cases could be completed filled out.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ExtendedContactDetail",
"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())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ExtendedContactDetail.id",
"path" : "ExtendedContactDetail.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" : "id"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ExtendedContactDetail.extension",
"path" : "ExtendedContactDetail.extension",
"slicing" : {
"discriminator" : [{
"type" : "value",
"path" : "url"
}],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : ["extensions",
"user content"],
"min" : 0,
"max" : "*",
"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,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "ExtendedContactDetail.purpose",
"path" : "ExtendedContactDetail.purpose",
"short" : "The type of contact",
"definition" : "The purpose/type of contact.",
"comment" : "If no purpose is defined, then these contact details may be used for any purpose.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ExtendedContactDetail.purpose",
"min" : 0,
"max" : "1"
},
"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())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/build/StructureDefinition/binding-definition",
"valueString" : "The purpose for which an extended contact detail should be used."
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Purpose"
}],
"strength" : "preferred",
"valueSet" : "http://terminology.hl7.org/ValueSet/contactentity-type"
}
},
{
"id" : "ExtendedContactDetail.name",
"path" : "ExtendedContactDetail.name",
"short" : "Name of an individual to contact",
"definition" : "The name of an individual to contact, some types of contact detail are usually blank.",
"comment" : "If there is no named individual, the telecom/address information is not generally monitored by a specific individual.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ExtendedContactDetail.name",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "HumanName"
}],
"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" : true
},
{
"id" : "ExtendedContactDetail.telecom",
"path" : "ExtendedContactDetail.telecom",
"short" : "Contact details (e.g.phone/fax/url)",
"definition" : "The contact details application for the purpose defined.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "ExtendedContactDetail.telecom",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactPoint"
}],
"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" : true
},
{
"id" : "ExtendedContactDetail.address",
"path" : "ExtendedContactDetail.address",
"short" : "Address for the contact",
"definition" : "Address for the contact.",
"comment" : "More than 1 address would be for different purposes, and thus should be entered as a different entry,.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ExtendedContactDetail.address",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Address"
}],
"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" : true
},
{
"id" : "ExtendedContactDetail.organization",
"path" : "ExtendedContactDetail.organization",
"short" : "This contact detail is handled/monitored by a specific organization",
"definition" : "This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization.",
"requirements" : "Some specific types of contact information can be an handled by an organization (eg legal council is via a specific firm).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ExtendedContactDetail.organization",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"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" : true
},
{
"id" : "ExtendedContactDetail.period",
"path" : "ExtendedContactDetail.period",
"short" : "Period that this contact was valid for usage",
"definition" : "Period that this contact was valid for usage.",
"comment" : "If the details have multiple periods, then enter in a new ExtendedContact with the new period.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ExtendedContactDetail.period",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Period"
}],
"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" : true
}]
},
"differential" : {
"element" : [{
"id" : "ExtendedContactDetail",
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
}],
"path" : "ExtendedContactDetail",
"short" : "Contact information",
"definition" : "Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization.",
"comment" : "This datatype may be sparsely populated, i.e. only contain a purpose and phone number or address, but other cases could be completed filled out.",
"min" : 0,
"max" : "*"
},
{
"id" : "ExtendedContactDetail.purpose",
"path" : "ExtendedContactDetail.purpose",
"short" : "The type of contact",
"definition" : "The purpose/type of contact.",
"comment" : "If no purpose is defined, then these contact details may be used for any purpose.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "CodeableConcept"
}],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/build/StructureDefinition/binding-definition",
"valueString" : "The purpose for which an extended contact detail should be used."
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Purpose"
}],
"strength" : "preferred",
"valueSet" : "http://terminology.hl7.org/ValueSet/contactentity-type"
}
},
{
"id" : "ExtendedContactDetail.name",
"path" : "ExtendedContactDetail.name",
"short" : "Name of an individual to contact",
"definition" : "The name of an individual to contact, some types of contact detail are usually blank.",
"comment" : "If there is no named individual, the telecom/address information is not generally monitored by a specific individual.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "HumanName"
}],
"isSummary" : true
},
{
"id" : "ExtendedContactDetail.telecom",
"path" : "ExtendedContactDetail.telecom",
"short" : "Contact details (e.g.phone/fax/url)",
"definition" : "The contact details application for the purpose defined.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "ContactPoint"
}],
"isSummary" : true
},
{
"id" : "ExtendedContactDetail.address",
"path" : "ExtendedContactDetail.address",
"short" : "Address for the contact",
"definition" : "Address for the contact.",
"comment" : "More than 1 address would be for different purposes, and thus should be entered as a different entry,.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Address"
}],
"isSummary" : true
},
{
"id" : "ExtendedContactDetail.organization",
"path" : "ExtendedContactDetail.organization",
"short" : "This contact detail is handled/monitored by a specific organization",
"definition" : "This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization.",
"requirements" : "Some specific types of contact information can be an handled by an organization (eg legal council is via a specific firm).",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Reference",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization"]
}],
"isSummary" : true
},
{
"id" : "ExtendedContactDetail.period",
"path" : "ExtendedContactDetail.period",
"short" : "Period that this contact was valid for usage",
"definition" : "Period that this contact was valid for usage.",
"comment" : "If the details have multiple periods, then enter in a new ExtendedContact with the new period.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "Period"
}],
"isSummary" : true
}]
}
}
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.