HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1 (Standard for Trial Use)
This page is part of the Occupational Data for Health (ODH) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions 
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="cimi-entity-Organization"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <p><b>ODH Organization Profile</b></p> <p>A social or legal structure formed by human beings.</p> <p><b>ODH Mapping Summary</b></p> <p><pre>cimi.entity.Organization maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization: OrganizationName maps to name OrganizationAlias maps to alias // I wish FHIR allowed multiple names, but it doesn't Type maps to type OrganizationIdentifier maps to identifier Address maps to address ContactPoint maps to contact ActiveFlag maps to active PartOf maps to partOf </pre></p> </div> </text> <url value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Organization"/> <identifier> <system value="http://hl7.org/fhir/us/odh"/> <value value="cimi.entity.Organization"/> </identifier> <version value="0.1.0"/> <name value="OrganizationProfile"/> <title value="ODH Organization Profile"/> <status value="draft"/> <date value="2018-08-17T00:00:00+10:00"/> <publisher value="HL7"/> <contact> <telecom> <system value="url"/> <value value="http://standardhealthrecord.org"/> </telecom> </contact> <description value="A social or legal structure formed by human beings."/> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166"/> <code value="US"/> <display value="United States of America"/> </coding> </jurisdiction> <fhirVersion value="3.0.1"/> <mapping> <identity value="servd"/> <uri value="http://www.omg.org/spec/ServD/1.0/"/> <name value="ServD"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2 Mapping"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/w5"/> <name value="W5 Mapping"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="Organization"/> <baseDefinition value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"/> <derivation value="constraint"/> <snapshot> <element id="Organization:cimi-entity-Organization"> <path value="Organization"/> <short value="ODH Organization Profile"/> <definition value="A social or legal structure formed by human beings."/> <min value="0"/> <max value="*"/> <base> <path value="Organization"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="dom-2"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/> <expression value="contained.contained.empty()"/> <xpath value="not(parent::f:contained and f:contained)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-1"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain any narrative"/> <expression value="contained.text.empty()"/> <xpath value="not(parent::f:contained and f:text)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-4"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-3"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource"/> <expression value="contained.where(('#'+id in %resource.descendants().reference).not()).empty()"/> <xpath value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"/> <source value="DomainResource"/> </constraint> <constraint> <key value="org-1"/> <severity value="error"/> <human value="The organization SHALL at least have a name or an id, and possibly more than one"/> <expression value="(identifier.count() + name.count()) > 0"/> <xpath value="count(f:identifier | f:name) > 0"/> <source value="Organization"/> </constraint> <mustSupport value="false"/> <mapping> <identity value="rim"/> <map value="Entity. Role, or Act"/> </mapping> <mapping> <identity value="v2"/> <map value="(also see master files messages)"/> </mapping> <mapping> <identity value="rim"/> <map value="Organization(classCode=ORG, determinerCode=INST)"/> </mapping> <mapping> <identity value="servd"/> <map value="Organization"/> </mapping> <mapping> <identity value="w5"/> <map value="administrative.group"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.id"> <path value="Organization.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comment value="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 value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <isSummary value="true"/> </element> <element id="Organization:cimi-entity-Organization.meta"> <path value="Organization.meta"/> <short value="Metadata about the resource"/> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Meta"/> </type> <isSummary value="true"/> </element> <element id="Organization:cimi-entity-Organization.implicitRules"> <path value="Organization.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comment value="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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="true"/> <isSummary value="true"/> </element> <element id="Organization:cimi-entity-Organization.language"> <path value="Organization.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comment value="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 value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages"/> </valueReference> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="A human language."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/languages"/> </valueSetReference> </binding> </element> <element id="Organization:cimi-entity-Organization.text"> <path value="Organization.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="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."/> <comment value="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 in formation is added later."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.contained"> <path value="Organization.contained"/> <short value="Contained, inline Resources"/> <definition value="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 value="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."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.extension"> <path value="Organization.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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 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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.modifierExtension"> <path value="Organization.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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 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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.identifier"> <path value="Organization.identifier"/> <short value="Identifies this organization across multiple systems"/> <definition value="Identifier for the organization that is used to identify the organization across multiple disparate systems."/> <requirements value="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 value="1"/> <max value="*"/> <base> <path value="Organization.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> <profile value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-OrganizationIdentifier"/> </type> <condition value="org-1"/> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XON.10 / XON.3"/> </mapping> <mapping> <identity value="rim"/> <map value=".scopes[Role](classCode=IDENT)"/> </mapping> <mapping> <identity value="servd"/> <map value="./Identifiers"/> </mapping> <mapping> <identity value="w5"/> <map value="id"/> </mapping> <mapping> <identity value="servd"/> <map value="n/a"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.identifier.id"> <path value="Organization.identifier.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.identifier.extension"> <path value="Organization.identifier.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order 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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.identifier.use"> <path value="Organization.identifier.use"/> <short value="usual | official | temp | secondary (If known)"/> <definition value="The purpose of this identifier."/> <comment value="This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary."/> <requirements value="Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers."/> <min value="0"/> <max value="1"/> <base> <path value="Identifier.use"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isModifier value="true"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="IdentifierUse"/> </extension> <strength value="required"/> <description value="Identifies the purpose for this identifier, if known ."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/identifier-use"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="N/A"/> </mapping> <mapping> <identity value="rim"/> <map value="Role.code or implied by context"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.identifier.type"> <path value="Organization.identifier.type"/> <short value="Description of identifier"/> <definition value="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose."/> <comment value="This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type."/> <requirements value="Allows users to make use of identifiers when the identifier system is not known."/> <min value="0"/> <max value="1"/> <base> <path value="Identifier.type"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="IdentifierType"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/identifier-type"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="CX.5"/> </mapping> <mapping> <identity value="rim"/> <map value="Role.code or implied by context"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.identifier.system"> <path value="Organization.identifier.system"/> <short value="The namespace for the identifier value"/> <definition value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique."/> <comment value="NPI preferred (http://hl7.org/fhir/sid/us-npi), Tax id is allowed (http://hl7.org/fhir/sid/us-tin), Local id is allowed in addition to 'authoritative' identifier."/> <requirements value="There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers."/> <min value="1"/> <max value="1"/> <base> <path value="Identifier.system"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="CX.4 / EI-2-4"/> </mapping> <mapping> <identity value="rim"/> <map value="II.root or Role.id.root"/> </mapping> <mapping> <identity value="servd"/> <map value="./IdentifierType"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.identifier.value"> <path value="Organization.identifier.value"/> <short value="The value that is unique"/> <definition value="The portion of the identifier typically relevant to the user and which is unique within the context of the system."/> <comment value="If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html)."/> <min value="0"/> <max value="1"/> <base> <path value="Identifier.value"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="CX.1 / EI.1"/> </mapping> <mapping> <identity value="rim"/> <map value="II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"/> </mapping> <mapping> <identity value="servd"/> <map value="./Value"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.identifier.period"> <path value="Organization.identifier.period"/> <short value="Time period when id is/was valid for use"/> <definition value="Time period during which identifier is/was valid for use."/> <min value="0"/> <max value="1"/> <base> <path value="Identifier.period"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="CX.7 + CX.8"/> </mapping> <mapping> <identity value="rim"/> <map value="Role.effectiveTime or implied by context"/> </mapping> <mapping> <identity value="servd"/> <map value="./StartDate and ./EndDate"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.identifier.assigner"> <path value="Organization.identifier.assigner"/> <short value="Organization that issued id (may be just text)"/> <definition value="Organization that issued/manages the identifier."/> <comment value="The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization."/> <min value="0"/> <max value="1"/> <base> <path value="Identifier.assigner"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="CX.4 / (CX.4,CX.9,CX.10)"/> </mapping> <mapping> <identity value="rim"/> <map value="II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"/> </mapping> <mapping> <identity value="servd"/> <map value="./IdentifierIssuingAuthority"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.active"> <path value="Organization.active"/> <short value="Whether the organization's record is still in active use"/> <definition value="Whether the organization's record is still in active use."/> <comment value="Default is true. This active flag is not intended to be used to mark an organizations 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. This element is labeled as a modifier because it may be used to mark that the resource was created in error."/> <requirements value="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 value="1"/> <max value="1"/> <base> <path value="Organization.active"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <defaultValueBoolean value="true"/> <mustSupport value="true"/> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="No equivalent in HL7 v2"/> </mapping> <mapping> <identity value="rim"/> <map value=".status"/> </mapping> <mapping> <identity value="servd"/> <map value="./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."/> </mapping> <mapping> <identity value="w5"/> <map value="status"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.type"> <path value="Organization.type"/> <short value="Kind of organization"/> <definition value="The kind(s) of organization that this is."/> <comment value="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 When 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. We expect that some jurisdictions will profile this optionality to be a single cardinality."/> <requirements value="Need to be able to track the kind of organization that this is - different organization types have different uses."/> <min value="1"/> <max value="1"/> <base> <path value="Organization.type"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="OrganizationType"/> </extension> <strength value="required"/> <description value="Used to categorize the organization"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/organization-type"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="No equivalent in v2"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> <mapping> <identity value="servd"/> <map value="n/a"/> </mapping> <mapping> <identity value="w5"/> <map value="class"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.name"> <path value="Organization.name"/> <short value="Name used for the organization"/> <definition value="A name associated with the organization."/> <comment value="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 value="Need to use the name as the label of the organization."/> <min value="1"/> <max value="1"/> <base> <path value="Organization.name"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <condition value="org-1"/> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XON.1"/> </mapping> <mapping> <identity value="rim"/> <map value=".name"/> </mapping> <mapping> <identity value="servd"/> <map value=".PreferredName/Name"/> </mapping> <mapping> <identity value="servd"/> <map value="./PrimaryAddress and ./OtherAddresses"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.alias"> <path value="Organization.alias"/> <short value="A list of alternate names that the organization is known as, or was known as in the past"/> <definition value="A list of alternate names that the organization is known as, or was known as in the past."/> <comment value="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 value="Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful."/> <min value="0"/> <max value="*"/> <base> <path value="Organization.alias"/> <min value="0"/> <max value="*"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value=".name"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.telecom"> <path value="Organization.telecom"/> <short value="A contact detail for the organization"/> <definition value="A contact detail for the organization."/> <comment value="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 value="Human contact for the organization."/> <min value="1"/> <max value="*"/> <base> <path value="Organization.telecom"/> <min value="0"/> <max value="*"/> </base> <type> <code value="ContactPoint"/> </type> <condition value="org-3"/> <constraint> <key value="org-3"/> <severity value="error"/> <human value="The telecom of an organization can never be of use 'home'"/> <expression value="where(use = 'home').empty()"/> <xpath value="count(f:use[@value='home']) = 0"/> <source value="Organization.telecom"/> </constraint> <mustSupport value="true"/> <mapping> <identity value="v2"/> <map value="ORC-22?"/> </mapping> <mapping> <identity value="rim"/> <map value=".telecom"/> </mapping> <mapping> <identity value="servd"/> <map value="./ContactPoints"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.address"> <path value="Organization.address"/> <short value="An address for the organization"/> <definition value="An address for the organization."/> <comment value="Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used."/> <requirements value="May need to keep track of the organization's addresses for contacting, billing or reporting requirements."/> <min value="1"/> <max value="*"/> <base> <path value="Organization.address"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Address"/> </type> <condition value="org-2"/> <constraint> <key value="org-2"/> <severity value="error"/> <human value="An address of an organization can never be of use 'home'"/> <expression value="where(use = 'home').empty()"/> <xpath value="count(f:use[@value='home']) = 0"/> <source value="Organization.address"/> </constraint> <mustSupport value="true"/> <mapping> <identity value="v2"/> <map value="ORC-23?"/> </mapping> <mapping> <identity value="rim"/> <map value=".address"/> </mapping> <mapping> <identity value="servd"/> <map value="./PrimaryAddress and ./OtherAddresses"/> </mapping> <mapping> <identity value="servd"/> <map value="n/a"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.address.id"> <path value="Organization.address.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.address.extension"> <path value="Organization.address.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order 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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.address.use"> <path value="Organization.address.use"/> <short value="home | work | temp | old - purpose of this address"/> <definition value="The purpose of this address."/> <comment value="This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old."/> <requirements value="Allows an appropriate address to be chosen from a list of many."/> <min value="0"/> <max value="1"/> <base> <path value="Address.use"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isModifier value="true"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AddressUse"/> </extension> <strength value="required"/> <description value="The use of an address"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/address-use"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="XAD.7"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./use)"/> </mapping> <mapping> <identity value="servd"/> <map value="./AddressPurpose"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.address.type"> <path value="Organization.address.type"/> <short value="postal | physical | both"/> <definition value="Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both."/> <min value="0"/> <max value="1"/> <base> <path value="Address.type"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AddressType"/> </extension> <strength value="required"/> <description value="The type of an address (physical / postal)"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/address-type"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="XAD.18"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./use)"/> </mapping> <mapping> <identity value="vcard"/> <map value="address type parameter"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.address.text"> <path value="Organization.address.text"/> <short value="Text representation of the address"/> <definition value="A full text representation of the address."/> <comment value="Can provide both a text representation and parts."/> <requirements value="A renderable, unencoded form."/> <min value="0"/> <max value="1"/> <base> <path value="Address.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"/> </mapping> <mapping> <identity value="rim"/> <map value="./formatted"/> </mapping> <mapping> <identity value="vcard"/> <map value="address label parameter"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.address.line"> <path value="Organization.address.line"/> <short value="Street name, number, direction & P.O. Box etc."/> <definition value="This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information."/> <requirements value="home | work | temp | old - purpose of this address."/> <min value="0"/> <max value="*"/> <base> <path value="Address.line"/> <min value="0"/> <max value="*"/> </base> <type> <code value="string"/> </type> <orderMeaning value="The order in which lines should appear in an address label"/> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = AL]"/> </mapping> <mapping> <identity value="vcard"/> <map value="street"/> </mapping> <mapping> <identity value="servd"/> <map value="./StreetAddress (newline delimitted)"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.address.city"> <path value="Organization.address.city"/> <short value="Name of city, town etc."/> <definition value="The name of the city, town, village or other community or delivery center."/> <alias value="Municpality"/> <min value="0"/> <max value="1"/> <base> <path value="Address.city"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XAD.3"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = CTY]"/> </mapping> <mapping> <identity value="vcard"/> <map value="locality"/> </mapping> <mapping> <identity value="servd"/> <map value="./Jurisdiction"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.address.district"> <path value="Organization.address.district"/> <short value="District name (aka county)"/> <definition value="The name of the administrative area (county)."/> <comment value="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 value="County"/> <min value="0"/> <max value="1"/> <base> <path value="Address.district"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XAD.9"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = CNT | CPA]"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.address.state"> <path value="Organization.address.state"/> <short value="Sub-unit of country (abbreviations ok)"/> <definition value="Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes)."/> <alias value="Province"/> <alias value="Territory"/> <min value="0"/> <max value="1"/> <base> <path value="Address.state"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="Two letter USPS alphabetic codes."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/usps-state"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="XAD.4"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = STA]"/> </mapping> <mapping> <identity value="vcard"/> <map value="region"/> </mapping> <mapping> <identity value="servd"/> <map value="./Region"/> </mapping> <mapping> <identity value="servd"/> <map value="./Sites"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.address.postalCode"> <path value="Organization.address.postalCode"/> <short value="US Zip Codes"/> <definition value="A postal code designating a region defined by the postal service."/> <alias value="Zip"/> <min value="0"/> <max value="1"/> <base> <path value="Address.postalCode"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XAD.5"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = ZIP]"/> </mapping> <mapping> <identity value="vcard"/> <map value="code"/> </mapping> <mapping> <identity value="servd"/> <map value="./PostalIdentificationCode"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.address.country"> <path value="Organization.address.country"/> <short value="Country (e.g. can be ISO 3166 2 or 3 letter code)"/> <definition value="Country - a nation as commonly understood or generally accepted."/> <comment value="ISO 3166 3 letter codes can be used in place of a full country name."/> <min value="0"/> <max value="1"/> <base> <path value="Address.country"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XAD.6"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = CNT]"/> </mapping> <mapping> <identity value="vcard"/> <map value="country"/> </mapping> <mapping> <identity value="servd"/> <map value="./Country"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.address.period"> <path value="Organization.address.period"/> <short value="Time period when address was/is in use"/> <definition value="Time period when address was/is in use."/> <requirements value="Allows addresses to be placed in historical context."/> <min value="0"/> <max value="1"/> <base> <path value="Address.period"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XAD.12 / XAD.13 + XAD.14"/> </mapping> <mapping> <identity value="rim"/> <map value="./usablePeriod[type="IVL<TS>"]"/> </mapping> <mapping> <identity value="servd"/> <map value="./StartDate and ./EndDate"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.partOf"> <path value="Organization.partOf"/> <short value="The organization of which this organization forms a part"/> <definition value="The organization of which this organization forms a part."/> <requirements value="Need to be able to track the hierarchy of organizations within an organization."/> <min value="0"/> <max value="1"/> <base> <path value="Organization.partOf"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Organization"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="No equivalent in HL7 v2"/> </mapping> <mapping> <identity value="rim"/> <map value=".playedBy[classCode=Part].scoper"/> </mapping> <mapping> <identity value="servd"/> <map value="n/a"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.contact"> <path value="Organization.contact"/> <short value="Contact for the organization for a certain purpose"/> <definition value="Contact for the organization for a certain purpose."/> <comment value="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 value="Need to keep track of assigned contact points within bigger organization."/> <min value="1"/> <max value="*"/> <base> <path value="Organization.contact"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <mapping> <identity value="rim"/> <map value=".contactParty"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.contact.id"> <path value="Organization.contact.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.contact.extension"> <path value="Organization.contact.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order 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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.contact.modifierExtension"> <path value="Organization.contact.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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 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 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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.contact.purpose"> <path value="Organization.contact.purpose"/> <short value="The type of contact"/> <definition value="Indicates a purpose for which the contact can be reached."/> <requirements value="Need to distinguish between multiple contact persons."/> <min value="0"/> <max value="1"/> <base> <path value="Organization.contact.purpose"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ContactPartyType"/> </extension> <strength value="extensible"/> <description value="The purpose for which you would contact a contact party"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/contactentity-type"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="./type"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.contact.name"> <path value="Organization.contact.name"/> <short value="A name associated with the contact"/> <definition value="A name associated with the contact."/> <requirements value="Need to be able to track the person by name."/> <min value="0"/> <max value="1"/> <base> <path value="Organization.contact.name"/> <min value="0"/> <max value="1"/> </base> <type> <code value="HumanName"/> </type> <mapping> <identity value="v2"/> <map value="PID-5, PID-9"/> </mapping> <mapping> <identity value="rim"/> <map value="./name"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.contact.telecom"> <path value="Organization.contact.telecom"/> <short value="Contact details (telephone, email, etc.) for a contact"/> <definition value="A contact detail (e.g. a telephone number or an email address) by which the party may be contacted."/> <requirements value="People have (primary) ways to contact them in some way such as phone, email."/> <min value="0"/> <max value="*"/> <base> <path value="Organization.contact.telecom"/> <min value="0"/> <max value="*"/> </base> <type> <code value="ContactPoint"/> </type> <mapping> <identity value="v2"/> <map value="PID-13, PID-14"/> </mapping> <mapping> <identity value="rim"/> <map value="./telecom"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.contact.address"> <path value="Organization.contact.address"/> <short value="Visiting or postal addresses for the contact"/> <definition value="Visiting or postal addresses for the contact."/> <requirements value="May need to keep track of a contact party's address for contacting, billing or reporting requirements."/> <min value="0"/> <max value="1"/> <base> <path value="Organization.contact.address"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Address"/> </type> <mapping> <identity value="v2"/> <map value="PID-11"/> </mapping> <mapping> <identity value="rim"/> <map value="./addr"/> </mapping> </element> <element id="Organization:cimi-entity-Organization.endpoint"> <path value="Organization.endpoint"/> <short value="Technical endpoints providing access to services operated for the organization"/> <definition value="Technical endpoints providing access to services operated for the organization."/> <requirements value="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 value="0"/> <max value="*"/> <base> <path value="Organization.endpoint"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Endpoint"/> </type> <mustSupport value="true"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> </snapshot> <differential> <element id="Organization:cimi-entity-Organization"> <path value="Organization"/> <short value="ODH Organization Profile"/> <definition value="A social or legal structure formed by human beings."/> <mustSupport value="false"/> </element> <element id="Organization:cimi-entity-Organization.identifier"> <path value="Organization.identifier"/> <type> <code value="Identifier"/> <profile value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-OrganizationIdentifier"/> </type> </element> <element id="Organization:cimi-entity-Organization.type"> <path value="Organization.type"/> <min value="1"/> <max value="1"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="OrganizationType"/> </extension> <strength value="required"/> <description value="Used to categorize the organization"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/organization-type"/> </valueSetReference> </binding> </element> <element id="Organization:cimi-entity-Organization.partOf"> <path value="Organization.partOf"/> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/odh/StructureDefinition/cimi-entity-Organization"/> </type> </element> <element id="Organization:cimi-entity-Organization.contact"> <path value="Organization.contact"/> <min value="1"/> <max value="*"/> </element> </differential> </StructureDefinition>
ODH Version: 0.1.0 ®© FHIR Version: 3.0.1 generated on Tue, Aug 21, 2018 16:12+1000.
| History
