. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Profile for organization
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"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, etc.\" class=\"dict\" href=\"organization-definitions.html#Organization\"><b>Organization</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier for the organization that is used to identify the organization across multiple disparate systems.\" class=\"dict\" href=\"organization-definitions.html#Organization.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: The organization SHALL at least have a name or an id, and possibly more than one\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Identifies this organization across multiple systems</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A name associated with the organization.\" class=\"dict\" href=\"organization-definitions.html#Organization.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: The organization SHALL at least have a name or an id, and possibly more than one\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Name used for the organization</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The kind of organization that this is.\" class=\"dict\" href=\"organization-definitions.html#Organization.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-organization-type.html\">Kind of organization</a></span><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"A contact detail for the organization.\" class=\"dict\" href=\"organization-definitions.html#Organization.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-3: The telecom of an organization can never be of use 'home'\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the organization</span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"An address for the organization.\" class=\"dict\" href=\"organization-definitions.html#Organization.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: An address of an organization can never be of use 'home'\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">An address for the organization</span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"The organization of which this organization forms a part.\" class=\"dict\" href=\"organization-definitions.html#Organization.partOf\"><b>partOf</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n The organization of which this organization forms a part</span><span style=\"color: Gray\"> --></span></partOf>\r\n <<a title=\"Contact for the organization for a certain purpose.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact\"><b>contact</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Contact for the organization for a certain purpose --></span>\r\n <<a title=\"Indicates a purpose for which the contact can be reached.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.purpose\"><b>purpose</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-contactentity-type.html\">The type of contact</a></span><span style=\"color: Gray\"> --></span></purpose>\r\n <<a title=\"A name associated with the contact.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the contact</span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact details (telephone, email, etc) for a contact</span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"Visiting or postal addresses for the contact.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Visiting or postal addresses for the contact</span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"organization-definitions.html#Organization.contact.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes</a></span><span style=\"color: Gray\"> --></span></gender>\r\n </contact>\r\n <<a title=\"Location(s) the organization uses to provide services.\" class=\"dict\" href=\"organization-definitions.html#Organization.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n Location(s) the organization uses to provide services</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Whether the organization's record is still in active use (this element modifies the meaning of other elements)\" class=\"dict\" href=\"organization-definitions.html#Organization.active\"><span style=\"text-decoration: underline\"><b>active</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether the organization's record is still in active use</span><span style=\"color: Gray\"> --></span>\r\n</Organization>\r\n</pre></div>"
},
"name": "organization",
"publisher": "FHIR Project",
"description": "Basic Profile. 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, etc.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource may be used in a shared registry of contact and other information for various organizations or it can be used merely as a support for other resources that need to reference organizations, perhaps as a document, message or as a contained resource. If using a registry approach, it's entirely possible for multiple registries to exist, each dealing with different types or levels of organization.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "servd",
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD"
}
],
"structure": [
{
"type": "Organization",
"publish": true,
"element": [
{
"path": "Organization",
"definition": {
"short": "A grouping of people or organizations with a common purpose",
"formal": "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, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "1",
"name": "AtLeastANameOrId",
"severity": "error",
"human": "The organization SHALL at least have a name or an id, and possibly more than one",
"xpath": "count(f:identifier | f:name) > 0"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Organization(classCode=ORG, determinerCode=INST)"
},
{
"identity": "v2",
"map": "(also see master files messages)"
},
{
"identity": "servd",
"map": "Organization"
}
]
}
},
{
"path": "Organization.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Organization.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Organization.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "Organization.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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.",
"comments": "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.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "Organization.identifier",
"definition": {
"short": "Identifies this organization across multiple systems",
"formal": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scopes[Role](classCode=IDENT)"
},
{
"identity": "v2",
"map": "XON.10 Organization Identifier / XON.3 ID Number"
},
{
"identity": "servd",
"map": "./Identifiers"
}
]
}
},
{
"path": "Organization.name",
"definition": {
"short": "Name used for the organization",
"formal": "A name associated with the organization.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".name"
},
{
"identity": "v2",
"map": "XON.1 Organization Name"
},
{
"identity": "servd",
"map": ".PreferredName/Name"
}
]
}
},
{
"path": "Organization.type",
"definition": {
"short": "Kind of organization",
"formal": "The kind of organization that this is.",
"comments": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "OrganizationType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/organization-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "No equivalent in v2"
},
{
"identity": "servd",
"map": "n/a"
}
]
}
},
{
"path": "Organization.telecom",
"definition": {
"short": "A contact detail for the organization",
"formal": "A contact detail for the organization.",
"comments": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"constraint": [
{
"key": "3",
"name": "NoHomeUseTelecom",
"severity": "error",
"human": "The telecom of an organization can never be of use 'home'",
"xpath": "count(f:use[@value='home']) = 0"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".telecom"
},
{
"identity": "v2",
"map": "No authoritative equivalent in V2.x"
},
{
"identity": "servd",
"map": "./ContactPoints"
}
]
}
},
{
"path": "Organization.address",
"definition": {
"short": "An address for the organization",
"formal": "An address for the organization.",
"comments": "Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
],
"constraint": [
{
"key": "2",
"name": "NoHomeUseAddress",
"severity": "error",
"human": "An address of an organization can never be of use 'home'",
"xpath": "count(f:use[@value='home']) = 0"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".address"
},
{
"identity": "v2",
"map": "No authoritative equivalent in V2.x; some V2.x segments such as OBX might provide a serialized instance value"
},
{
"identity": "servd",
"map": "./PrimaryAddress and ./OtherAddresses"
}
]
}
},
{
"path": "Organization.partOf",
"definition": {
"short": "The organization of which this organization forms a part",
"formal": "The organization of which this organization forms a part.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".playedBy[classCode=Part].scoper"
},
{
"identity": "v2",
"map": "No equivalent in V2.x"
},
{
"identity": "servd",
"map": "n/a"
}
]
}
},
{
"path": "Organization.contact",
"definition": {
"short": "Contact for the organization for a certain purpose",
"formal": "Contact for the organization for a certain purpose.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".contactParty"
}
]
}
},
{
"path": "Organization.contact.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Organization.contact.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "Organization.contact.purpose",
"definition": {
"short": "The type of contact",
"formal": "Indicates a purpose for which the contact can be reached.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ContactPartyType",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/contactentity-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "./type"
}
]
}
},
{
"path": "Organization.contact.name",
"definition": {
"short": "A name associated with the contact",
"formal": "A name associated with the contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./name"
},
{
"identity": "v2",
"map": "PID-5, PID-9"
}
]
}
},
{
"path": "Organization.contact.telecom",
"definition": {
"short": "Contact details (telephone, email, etc) for a contact",
"formal": "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./telecom"
},
{
"identity": "v2",
"map": "PID-13, PID-14"
}
]
}
},
{
"path": "Organization.contact.address",
"definition": {
"short": "Visiting or postal addresses for the contact",
"formal": "Visiting or postal addresses for the contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./addr"
},
{
"identity": "v2",
"map": "PID-11"
}
]
}
},
{
"path": "Organization.contact.gender",
"definition": {
"short": "Gender for administrative purposes",
"formal": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AdministrativeGender",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "rim",
"map": "./administrativeGender"
},
{
"identity": "v2",
"map": "PID-8"
}
]
}
},
{
"path": "Organization.location",
"definition": {
"short": "Location(s) the organization uses to provide services",
"formal": "Location(s) the organization uses to provide services.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".scopedBy[classCode=LocatedEntity].scoper"
},
{
"identity": "servd",
"map": "./Sites"
}
]
}
},
{
"path": "Organization.active",
"definition": {
"short": "Whether the organization's record is still in active use",
"formal": "Whether the organization's record is still in active use.",
"comments": "Default is true.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".status"
},
{
"identity": "v2",
"map": "No equivalent in V2.x"
},
{
"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."
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "active",
"type": "token",
"documentation": "Whether the organization's record is active",
"xpath": "f:Organization/f:active"
},
{
"name": "identifier",
"type": "token",
"documentation": "Any identifier for the organization (not the accreditation issuer's identifier)",
"xpath": "f:Organization/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "A portion of the organization's name",
"xpath": "f:Organization/f:name"
},
{
"name": "partof",
"type": "reference",
"documentation": "Search all organizations that are part of the given organization",
"xpath": "f:Organization/f:partOf"
},
{
"name": "phonetic",
"type": "string",
"documentation": "A portion of the organization's name using some kind of phonetic matching algorithm"
},
{
"name": "type",
"type": "token",
"documentation": "A code for the type of organization",
"xpath": "f:Organization/f:type"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:10+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change