Da Vinci Prior Authorization Support (PAS) FHIR IG
2.1.0 - STU 2
Da Vinci Prior Authorization Support (PAS) FHIR IG
2.1.0 - STU 2
Da Vinci Prior Authorization Support (PAS) FHIR IG, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pas/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 3 |
JSON representation of the profile-requestor resource profile.
{
"resourceType" : "StructureDefinition",
"id" : "profile-requestor",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition profile-requestor</b></p><a name=\"profile-requestor\"> </a><a name=\"hcprofile-requestor\"> </a><a name=\"profile-requestor-en-US\"> </a><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-profile-requestor-definitions.html#Organization\">Organization</a><a name=\"Organization\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-profile-organization.html\">PASOrganization</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"font-weight:bold\">This profile also complies with the profiles </span><a style=\"font-weight:bold; font-weight:bold\" href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-organization.html\">US Core Organization Profile (3.1.1)</a> and <a style=\"font-weight:bold; font-weight:bold\" href=\"http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-organization.html\">US Core Organization Profile (6.1.0)</a></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-profile-requestor-definitions.html#Organization.type\">type</a><a name=\"Organization.type\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"padding-left: 3px; padding-right: 3px; color: white; background-color: red\" title=\"This element must be supported\">S</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Kind of organization</span><br/><span style=\"font-weight:bold\">Binding: </span><a href=\"https://valueset.x12.org/x217/005010/response/2010B/NM1/1/01/00/98\">https://valueset.x12.org/x217/005010/response/2010B/NM1/1/01/00/98</a> (<a href=\"http://hl7.org/fhir/R4/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\">required</a>): Codes identifying an organizational entity, a physical location, property or an individual. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.<br/><br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-profile-requestor-definitions.html#Organization.contact\">contact</a><a name=\"Organization.contact\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"padding-left: 3px; padding-right: 3px; color: white; background-color: red\" title=\"This element must be supported\">S</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#BackboneElement\">BackboneElement</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Contact for the organization for a certain purpose</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck010.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-profile-requestor-definitions.html#Organization.contact.name\">name</a><a name=\"Organization.contact.name\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"padding-left: 3px; padding-right: 3px; color: white; background-color: red\" title=\"This element must be supported\">S</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#HumanName\">HumanName</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">A name associated with the contact</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-profile-requestor-definitions.html#Organization.contact.telecom\">telecom</a><a name=\"Organization.contact.telecom\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"padding-left: 3px; padding-right: 3px; color: white; background-color: red\" title=\"This element must be supported\">S</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#ContactPoint\">ContactPoint</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Contact details (telephone, email, etc.) for a contact</span></td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-compliesWithProfile",
"valueCanonical" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|3.1.1"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-compliesWithProfile",
"valueCanonical" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|6.1.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fm"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/davinci-pas/ImplementationGuide/hl7.fhir.us.davinci-pas"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/davinci-pas/ImplementationGuide/hl7.fhir.us.davinci-pas"
}
]
}
}
],
"url" : "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-requestor",
"version" : "2.1.0",
"name" : "PASRequestor",
"title" : "PAS Requestor Organization",
"status" : "active",
"date" : "2024-11-19T20:11:15+00:00",
"publisher" : "HL7 International / Financial Management",
"contact" : [
{
"name" : "HL7 International / Financial Management",
"telecom" : [
{
"system" : "url",
"value" : "http://hl7.org/Special/committees/fm"
},
{
"system" : "email",
"value" : "fmlists@lists.hl7.org"
}
]
},
{
"name" : "Jean Duteau",
"telecom" : [
{
"system" : "email",
"value" : "mailto:jean@duteaudesign.com"
}
]
},
{
"name" : "HL7 International / Financial Management",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fm"
}
]
}
],
"description" : "The organization who is making a prior authorization request.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"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"
},
{
"identity" : "servd",
"uri" : "http://www.omg.org/spec/ServD/1.0/",
"name" : "ServD"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern Mapping"
}
],
"kind" : "resource",
"abstract" : false,
"type" : "Organization",
"baseDefinition" : "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-organization",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "Organization",
"path" : "Organization",
"short" : "A grouping of people or organizations with a common purpose",
"definition" : "A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.`div`.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key" : "org-1",
"severity" : "error",
"human" : "The organization SHALL at least have a name or an identifier, and possibly more than one",
"expression" : "(identifier.count() + name.count()) > 0",
"xpath" : "count(f:identifier | f:name) > 0",
"source" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "(also see master files messages)"
},
{
"identity" : "rim",
"map" : "Organization(classCode=ORG, determinerCode=INST)"
},
{
"identity" : "servd",
"map" : "Organization"
}
]
},
{
"id" : "Organization.id",
"path" : "Organization.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.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" : true
},
{
"id" : "Organization.meta",
"path" : "Organization.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Meta"
}
],
"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" : "Organization.implicitRules",
"path" : "Organization.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"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" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "Organization.language",
"path" : "Organization.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"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())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
}
],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "Organization.text",
"path" : "Organization.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias" : [
"narrative",
"html",
"xhtml",
"display"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Narrative"
}
],
"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" : "Act.text?"
}
]
},
{
"id" : "Organization.contained",
"path" : "Organization.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : [
"inline resources",
"anonymous resources",
"contained resources"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Resource"
}
],
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Organization.extension",
"path" : "Organization.extension",
"short" : "Additional content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. 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" : "DomainResource.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" : "Organization.modifierExtension",
"path" : "Organization.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"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" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Organization.identifier",
"path" : "Organization.identifier",
"slicing" : {
"discriminator" : [
{
"type" : "pattern",
"path" : "$this"
}
],
"rules" : "open"
},
"short" : "Identifies this organization across multiple systems",
"definition" : "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"comment" : "NPI preferred.",
"requirements" : "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier",
"profile" : [
🔗 "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-identifier"
]
}
],
"condition" : [
"org-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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "XON.10 / XON.3"
},
{
"identity" : "rim",
"map" : ".scopes[Role](classCode=IDENT)"
},
{
"identity" : "servd",
"map" : "./Identifiers"
}
]
},
{
"id" : "Organization.identifier:NPI",
"path" : "Organization.identifier",
"sliceName" : "NPI",
"short" : "An identifier intended for computation",
"definition" : "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.",
"requirements" : "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier",
"profile" : [
🔗 "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-identifier"
]
}
],
"patternIdentifier" : {
"system" : "http://hl7.org/fhir/sid/us-npi"
},
"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" : "us-core-16",
"severity" : "error",
"human" : "NPI must be 10 digits",
"expression" : "value.matches('^[0-9]{10}$')",
"xpath" : "f:value/f:matches(value,/^[0-9]{10}$/)",
"source" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
},
{
"key" : "us-core-17",
"severity" : "error",
"human" : "NPI check digit must be valid (Luhn algorithm check)",
"expression" : "(((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)",
"source" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
}
],
"mustSupport" : true,
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"map" : "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
"identity" : "servd",
"map" : "Identifier"
}
]
},
{
"id" : "Organization.identifier:CLIA",
"path" : "Organization.identifier",
"sliceName" : "CLIA",
"short" : "An identifier intended for computation",
"definition" : "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.",
"requirements" : "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier",
"profile" : [
🔗 "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-identifier"
]
}
],
"patternIdentifier" : {
"system" : "urn:oid:2.16.840.1.113883.4.7"
},
"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" : "us-core-18",
"severity" : "error",
"human" : "CLIA number must be 10 digits with a letter \"D\" in third position",
"expression" : "value.matches('^[0-9]{2}D[0-9]{7}$')",
"xpath" : "f:value/f:matches(value,/^[0-9]{2}D[0-9]{7}$/)",
"source" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
}
],
"mustSupport" : false,
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"map" : "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
"identity" : "servd",
"map" : "Identifier"
}
]
},
{
"id" : "Organization.identifier:NAIC",
"path" : "Organization.identifier",
"sliceName" : "NAIC",
"short" : "An identifier intended for computation",
"definition" : "An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.",
"comment" : "NAIC Company code (sometimes called \"NAIC Number\" or \"cocode\") for payers.",
"requirements" : "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier",
"profile" : [
🔗 "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-identifier"
]
}
],
"patternIdentifier" : {
"system" : "urn:oid:2.16.840.1.113883.6.300"
},
"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" : "us-core-19",
"severity" : "error",
"human" : "NAIC must be 5 digits",
"expression" : "value.matches('^[0-9]{5}$')",
"xpath" : "f:value/f:matches(value,/^[0-9]{5}$/)",
"source" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
}
],
"mustSupport" : false,
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"map" : "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
"identity" : "servd",
"map" : "Identifier"
}
]
},
{
"id" : "Organization.identifier:TIN",
"path" : "Organization.identifier",
"sliceName" : "TIN",
"short" : "The US Employer Identification Number (EIN) or Tax Identification Number (TIN).",
"definition" : "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"comment" : "NPI preferred.",
"requirements" : "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"patternIdentifier" : {
"system" : "http://terminology.hl7.org/NamingSystem/USEIN"
},
"condition" : [
"org-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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "XON.10 / XON.3"
},
{
"identity" : "rim",
"map" : ".scopes[Role](classCode=IDENT)"
},
{
"identity" : "servd",
"map" : "./Identifiers"
}
]
},
{
"id" : "Organization.identifier:PI",
"path" : "Organization.identifier",
"sliceName" : "PI",
"short" : "The Payer Identification Number (PI)",
"definition" : "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"comment" : "NPI preferred.",
"requirements" : "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"patternIdentifier" : {
"type" : {
"coding" : [
{
"system" : "http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType",
"code" : "payerid"
}
]
}
},
"condition" : [
"org-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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.identifier"
},
{
"identity" : "v2",
"map" : "XON.10 / XON.3"
},
{
"identity" : "rim",
"map" : ".scopes[Role](classCode=IDENT)"
},
{
"identity" : "servd",
"map" : "./Identifiers"
}
]
},
{
"id" : "Organization.active",
"path" : "Organization.active",
"short" : "Whether the organization's record is still in active use",
"definition" : "Whether the organization's record is still in active use.",
"comment" : "This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.\n\nThis element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"requirements" : "Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Organization.active",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"meaningWhenMissing" : "This resource is generally assumed to be active if no value is provided for the active element",
"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"
}
],
"mustSupport" : true,
"isModifier" : true,
"isModifierReason" : "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.status"
},
{
"identity" : "v2",
"map" : "No equivalent in HL7 v2"
},
{
"identity" : "rim",
"map" : ".status"
},
{
"identity" : "servd",
"map" : "./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date."
}
]
},
{
"id" : "Organization.type",
"path" : "Organization.type",
"short" : "Kind of organization",
"definition" : "The kind(s) of organization that this is.",
"comment" : "Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes\n\nWhen considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.\n\nWe expect that some jurisdictions will profile this optionality to be a single cardinality.",
"requirements" : "Need to be able to track the kind of organization that this is - different organization types have different uses.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.type",
"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())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"strength" : "required",
"description" : "Codes identifying an organizational entity, a physical location, property or an individual. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.",
"valueSet" : "https://valueset.x12.org/x217/005010/response/2010B/NM1/1/01/00/98"
},
"mapping" : [
{
"identity" : "w5",
"map" : "FiveWs.class"
},
{
"identity" : "v2",
"map" : "No equivalent in v2"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "servd",
"map" : "n/a"
}
]
},
{
"id" : "Organization.name",
"path" : "Organization.name",
"short" : "Name used for the organization",
"definition" : "A name associated with the organization.",
"comment" : "If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.",
"requirements" : "Need to use the name as the label of the organization.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Organization.name",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"org-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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "XON.1"
},
{
"identity" : "rim",
"map" : ".name"
},
{
"identity" : "servd",
"map" : ".PreferredName/Name"
}
]
},
{
"id" : "Organization.alias",
"path" : "Organization.alias",
"short" : "A list of alternate names that the organization is known as, or was known as in the past",
"definition" : "A list of alternate names that the organization is known as, or was known as in the past.",
"comment" : "There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.",
"requirements" : "Over time locations and organizations go through many changes and can be known by different names.\n\nFor searching knowing previous names that the organization was known by can be very useful.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.alias",
"min" : 0,
"max" : "*"
},
"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" : ".name"
}
]
},
{
"id" : "Organization.telecom",
"path" : "Organization.telecom",
"short" : "A contact detail for the organization",
"definition" : "A contact detail for the organization.",
"comment" : "The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.",
"requirements" : "Human contact for the organization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "ContactPoint"
}
],
"condition" : [
"org-3"
],
"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" : "org-3",
"severity" : "error",
"human" : "The telecom of an organization can never be of use 'home'",
"expression" : "where(use = 'home').empty()",
"xpath" : "count(f:use[@value='home']) = 0",
"source" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "ORC-22?"
},
{
"identity" : "rim",
"map" : ".telecom"
},
{
"identity" : "servd",
"map" : "./ContactPoints"
}
]
},
{
"id" : "Organization.telecom.id",
"path" : "Organization.telecom.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" : "Organization.telecom.extension",
"path" : "Organization.telecom.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" : "Organization.telecom.system",
"path" : "Organization.telecom.system",
"short" : "phone | fax | email | pager | url | sms | other",
"definition" : "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"cpt-2"
],
"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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactPointSystem"
}
],
"strength" : "required",
"description" : "Telecommunications form for contact point.",
"valueSet" : "http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1"
},
"mapping" : [
{
"identity" : "v2",
"map" : "XTN.3"
},
{
"identity" : "rim",
"map" : "./scheme"
},
{
"identity" : "servd",
"map" : "./ContactPointType"
}
]
},
{
"id" : "Organization.telecom.value",
"path" : "Organization.telecom.value",
"short" : "The actual contact point details",
"definition" : "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"comment" : "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"requirements" : "Need to support legacy numbers that are not in a tightly controlled format.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.value",
"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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "XTN.1 (or XTN.12)"
},
{
"identity" : "rim",
"map" : "./url"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Organization.telecom.use",
"path" : "Organization.telecom.use",
"short" : "home | work | temp | old | mobile - purpose of this contact point",
"definition" : "Identifies the purpose for the contact point.",
"comment" : "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"requirements" : "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.use",
"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())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactPointUse"
}
],
"strength" : "required",
"description" : "Use of contact point.",
"valueSet" : "http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1"
},
"mapping" : [
{
"identity" : "v2",
"map" : "XTN.2 - but often indicated by field"
},
{
"identity" : "rim",
"map" : "unique(./use)"
},
{
"identity" : "servd",
"map" : "./ContactPointPurpose"
}
]
},
{
"id" : "Organization.telecom.rank",
"path" : "Organization.telecom.rank",
"short" : "Specify preferred order of use (1 = highest)",
"definition" : "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.",
"comment" : "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.rank",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "positiveInt"
}
],
"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,
"mapping" : [
{
"identity" : "v2",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Organization.telecom.period",
"path" : "Organization.telecom.period",
"short" : "Time period when the contact point was/is in use",
"definition" : "Time period when the contact point was/is in use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.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,
"mapping" : [
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "./usablePeriod[type=\"IVL<TS>\"]"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Organization.address",
"path" : "Organization.address",
"short" : "An address for the organization",
"definition" : "An address for the organization.",
"comment" : "Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.",
"requirements" : "May need to keep track of the organization's addresses for contacting, billing or reporting requirements.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.address",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Address"
}
],
"condition" : [
"org-2"
],
"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" : "org-2",
"severity" : "error",
"human" : "An address of an organization can never be of use 'home'",
"expression" : "where(use = 'home').empty()",
"xpath" : "count(f:use[@value='home']) = 0",
"source" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "ORC-23?"
},
{
"identity" : "rim",
"map" : ".address"
},
{
"identity" : "servd",
"map" : "./PrimaryAddress and ./OtherAddresses"
}
]
},
{
"id" : "Organization.address.id",
"path" : "Organization.address.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" : "Organization.address.extension",
"path" : "Organization.address.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" : "Organization.address.use",
"path" : "Organization.address.use",
"short" : "home | work | temp | old | billing - purpose of this address",
"definition" : "The purpose of this address.",
"comment" : "Applications can assume that an address is current unless it explicitly says that it is temporary or old.",
"requirements" : "Allows an appropriate address to be chosen from a list of many.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"example" : [
{
"label" : "General",
"valueCode" : "home"
}
],
"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" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one",
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AddressUse"
}
],
"strength" : "required",
"description" : "The use of an address.",
"valueSet" : "http://hl7.org/fhir/ValueSet/address-use|4.0.1"
},
"mapping" : [
{
"identity" : "v2",
"map" : "XAD.7"
},
{
"identity" : "rim",
"map" : "unique(./use)"
},
{
"identity" : "servd",
"map" : "./AddressPurpose"
}
]
},
{
"id" : "Organization.address.type",
"path" : "Organization.address.type",
"short" : "postal | physical | both",
"definition" : "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
"comment" : "The definition of Address states that \"address is intended to describe postal addresses, not physical locations\". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](http://hl7.org/fhir/R4/location.html#) resource).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"example" : [
{
"label" : "General",
"valueCode" : "both"
}
],
"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/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AddressType"
}
],
"strength" : "required",
"description" : "The type of an address (physical / postal).",
"valueSet" : "http://hl7.org/fhir/ValueSet/address-type|4.0.1"
},
"mapping" : [
{
"identity" : "v2",
"map" : "XAD.18"
},
{
"identity" : "rim",
"map" : "unique(./use)"
},
{
"identity" : "vcard",
"map" : "address type parameter"
}
]
},
{
"id" : "Organization.address.text",
"path" : "Organization.address.text",
"short" : "Text representation of the address",
"definition" : "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.",
"comment" : "Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.",
"requirements" : "A renderable, unencoded form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "137 Nowhere Street, Erewhon 9132"
}
],
"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,
"mapping" : [
{
"identity" : "v2",
"map" : "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"
},
{
"identity" : "rim",
"map" : "./formatted"
},
{
"identity" : "vcard",
"map" : "address label parameter"
}
]
},
{
"id" : "Organization.address.line",
"path" : "Organization.address.line",
"short" : "Street name, number, direction & P.O. Box etc.",
"definition" : "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.",
"min" : 0,
"max" : "4",
"base" : {
"path" : "Address.line",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"orderMeaning" : "The order in which lines should appear in an address label",
"example" : [
{
"label" : "General",
"valueString" : "137 Nowhere Street"
},
{
"label" : "General",
"valueString" : "49 MEADOW ST"
}
],
"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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = AL]"
},
{
"identity" : "vcard",
"map" : "street"
},
{
"identity" : "servd",
"map" : "./StreetAddress (newline delimitted)"
}
]
},
{
"id" : "Organization.address.city",
"path" : "Organization.address.city",
"short" : "Name of city, town etc.",
"definition" : "The name of the city, town, suburb, village or other community or delivery center.",
"alias" : [
"Municpality"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.city",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "Erewhon"
},
{
"label" : "General",
"valueString" : "EVERYTOWN"
}
],
"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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "XAD.3"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = CTY]"
},
{
"identity" : "vcard",
"map" : "locality"
},
{
"identity" : "servd",
"map" : "./Jurisdiction"
}
]
},
{
"id" : "Organization.address.district",
"path" : "Organization.address.district",
"short" : "District name (aka county)",
"definition" : "The name of the administrative area (county).",
"comment" : "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.",
"alias" : [
"County"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.district",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "Madison"
}
],
"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,
"mapping" : [
{
"identity" : "v2",
"map" : "XAD.9"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = CNT | CPA]"
}
]
},
{
"id" : "Organization.address.state",
"path" : "Organization.address.state",
"short" : "Sub-unit of country (abbreviations ok)",
"definition" : "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).",
"alias" : [
"Province",
"Territory"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.state",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "OK"
}
],
"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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"binding" : {
"strength" : "extensible",
"description" : "Two letter USPS alphabetic codes.",
"valueSet" : "http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state"
},
"mapping" : [
{
"identity" : "v2",
"map" : "XAD.4"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = STA]"
},
{
"identity" : "vcard",
"map" : "region"
},
{
"identity" : "servd",
"map" : "./Region"
}
]
},
{
"id" : "Organization.address.postalCode",
"path" : "Organization.address.postalCode",
"short" : "US Zip Codes",
"definition" : "A postal code designating a region defined by the postal service.",
"alias" : [
"Zip"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.postalCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "9132"
},
{
"label" : "General",
"valueString" : "74047"
}
],
"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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "XAD.5"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = ZIP]"
},
{
"identity" : "vcard",
"map" : "code"
},
{
"identity" : "servd",
"map" : "./PostalIdentificationCode"
}
]
},
{
"id" : "Organization.address.country",
"path" : "Organization.address.country",
"short" : "Country (e.g. can be ISO 3166 2 or 3 letter code)",
"definition" : "Country - a nation as commonly understood or generally accepted.",
"comment" : "ISO 3166 3 letter codes can be used in place of a human readable country name.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.country",
"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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "XAD.6"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = CNT]"
},
{
"identity" : "vcard",
"map" : "country"
},
{
"identity" : "servd",
"map" : "./Country"
}
]
},
{
"id" : "Organization.address.period",
"path" : "Organization.address.period",
"short" : "Time period when address was/is in use",
"definition" : "Time period when address was/is in use.",
"requirements" : "Allows addresses to be placed in historical context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"example" : [
{
"label" : "General",
"valuePeriod" : {
"start" : "2010-03-23",
"end" : "2010-07-01"
}
}
],
"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,
"mapping" : [
{
"identity" : "v2",
"map" : "XAD.12 / XAD.13 + XAD.14"
},
{
"identity" : "rim",
"map" : "./usablePeriod[type=\"IVL<TS>\"]"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Organization.partOf",
"path" : "Organization.partOf",
"short" : "The organization of which this organization forms a part",
"definition" : "The organization of which this organization forms a part.",
"requirements" : "Need to be able to track the hierarchy of organizations within an organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.partOf",
"min" : 0,
"max" : "1"
},
"type" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean" : true
}
],
"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,
"mapping" : [
{
"identity" : "v2",
"map" : "No equivalent in HL7 v2"
},
{
"identity" : "rim",
"map" : ".playedBy[classCode=Part].scoper"
},
{
"identity" : "servd",
"map" : "n/a"
}
]
},
{
"id" : "Organization.contact",
"path" : "Organization.contact",
"short" : "Contact for the organization for a certain purpose",
"definition" : "Contact for the organization for a certain purpose.",
"comment" : "Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.",
"requirements" : "Need to keep track of assigned contact points within bigger organization.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.contact",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : ".contactParty"
}
]
},
{
"id" : "Organization.contact.id",
"path" : "Organization.contact.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" : "Organization.contact.extension",
"path" : "Organization.contact.extension",
"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" : "Organization.contact.modifierExtension",
"path" : "Organization.contact.modifierExtension",
"short" : "Extensions that cannot be ignored even if unrecognized",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"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" : true,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Organization.contact.purpose",
"path" : "Organization.contact.purpose",
"short" : "The type of contact",
"definition" : "Indicates a purpose for which the contact can be reached.",
"requirements" : "Need to distinguish between multiple contact persons.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.contact.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" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactPartyType"
}
],
"strength" : "extensible",
"description" : "The purpose for which you would contact a contact party.",
"valueSet" : "http://hl7.org/fhir/ValueSet/contactentity-type"
},
"mapping" : [
{
"identity" : "rim",
"map" : "./type"
}
]
},
{
"id" : "Organization.contact.name",
"path" : "Organization.contact.name",
"short" : "A name associated with the contact",
"definition" : "A name associated with the contact.",
"requirements" : "Need to be able to track the person by name.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.contact.name",
"min" : 0,
"max" : "1"
},
"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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "PID-5, PID-9"
},
{
"identity" : "rim",
"map" : "./name"
}
]
},
{
"id" : "Organization.contact.telecom",
"path" : "Organization.contact.telecom",
"short" : "Contact details (telephone, email, etc.) for a contact",
"definition" : "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.",
"requirements" : "People have (primary) ways to contact them in some way such as phone, email.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.contact.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"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "PID-13, PID-14"
},
{
"identity" : "rim",
"map" : "./telecom"
}
]
},
{
"id" : "Organization.contact.address",
"path" : "Organization.contact.address",
"short" : "Visiting or postal addresses for the contact",
"definition" : "Visiting or postal addresses for the contact.",
"requirements" : "May need to keep track of a contact party's address for contacting, billing or reporting requirements.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Organization.contact.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" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "PID-11"
},
{
"identity" : "rim",
"map" : "./addr"
}
]
},
{
"id" : "Organization.endpoint",
"path" : "Organization.endpoint",
"short" : "Technical endpoints providing access to services operated for the organization",
"definition" : "Technical endpoints providing access to services operated for the organization.",
"requirements" : "Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Organization.endpoint",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Endpoint"
]
}
],
"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" : "Organization.type",
"path" : "Organization.type",
"mustSupport" : true,
"binding" : {
"strength" : "required",
"description" : "Codes identifying an organizational entity, a physical location, property or an individual. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.",
"valueSet" : "https://valueset.x12.org/x217/005010/response/2010B/NM1/1/01/00/98"
}
},
{
"id" : "Organization.contact",
"path" : "Organization.contact",
"mustSupport" : true
},
{
"id" : "Organization.contact.name",
"path" : "Organization.contact.name",
"mustSupport" : true
},
{
"id" : "Organization.contact.telecom",
"path" : "Organization.contact.telecom",
"mustSupport" : true
}
]
}
}
IG © 2020+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-pas#2.1.0 based on FHIR 4.0.1. Generated 2024-11-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change