{ "resourceType": "StructureDefinition", "constrainedType": "Organization", "base": "http://hl7.org/fhir/StructureDefinition/Organization", "meta": { "lastUpdated": "2015-09-22T10:02:49.724+00:00" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 4 } ], "url": "http://hl7.no/fhir/StructureDefinition/LabOrganizationNorway", "name": "LabOrganizationNorway", "status": "draft", "date": "2015-09-22T10:02:49+00:00", "description": "Base StructureDefinition for Organization Resource", "fhirVersion": "1.0.1", "mapping": [ { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM" }, { "identity": "servd", "uri": "http://www.omg.org/spec/ServD/1.0/", "name": "ServD" }, { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" } ], "kind": "resource", "abstract": false, "snapshot": { "element": [ { "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, etc.", "min": 0, "max": "*", "base": { "path": "Organization", "min": 0, "max": "*" }, "type": [ { "code": "Organization" } ], "constraint": [ { "key": "org-1", "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" } ], "mapping": [ { "identity": "v2", "map": "(also see master files messages)" }, { "identity": "rim", "map": "Organization(classCode=ORG, determinerCode=INST)" }, { "identity": "servd", "map": "Organization" }, { "identity": "w5", "map": "administrative.group" } ] }, { "path": "Organization.identifier", "slicing": { "rules": "openAtEnd" }, "short": "Identifies this organization across multiple systems", "definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.", "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" } ], "condition": [ "org-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XON.10 / XON.3" }, { "identity": "rim", "map": ".scopes[Role](classCode=IDENT)" }, { "identity": "servd", "map": "./Identifiers" }, { "identity": "w5", "map": "id" } ] }, { "comments": "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.", "path": "Organization.identifier.use", "short": "usual | official | temp | secondary (If known)", "definition": "The purpose of this identifier.", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 0, "max": "1", "base": { "path": "Identifier.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "Identifies the purpose for this identifier, if known .", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-use" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "comments": "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.", "path": "Organization.identifier.type", "short": "Description of identifier", "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 0, "max": "1", "base": { "path": "Identifier.type", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "extensible", "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-type" } }, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.", "path": "Organization.identifier.type.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "comments": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.", "path": "Organization.identifier.type.coding.system", "short": "Identity of the terminology system", "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 0, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "comments": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "path": "Organization.identifier.type.coding.version", "short": "Version of the system - if relevant", "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "min": 0, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "path": "Organization.identifier.type.coding.code", "short": "Symbol in syntax defined by the system", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "requirements": "Need to refer to a particular code in the system.", "min": 0, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "path": "Organization.identifier.type.coding.display", "short": "Representation defined by the system", "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 0, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "comments": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "path": "Organization.identifier.type.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ] }, { "comments": "Very often the text is the same as a displayName of one of the codings.", "path": "Organization.identifier.type.text", "short": "Plain text representation of the concept", "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "exampleUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri", "path": "Organization.identifier.system", "short": "The namespace for the identifier", "definition": "Establishes the namespace in which set of possible id values is unique.", "requirements": "There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.", "min": 0, "max": "1", "base": { "path": "Identifier.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ] }, { "comments": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.", "exampleString": "123456", "path": "Organization.identifier.value", "short": "The value that is unique", "definition": "The portion of the identifier typically displayed to the user and which is unique within the context of the system.", "min": 0, "max": "1", "base": { "path": "Identifier.value", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ] }, { "path": "Organization.identifier.period", "short": "Time period when id is/was valid for use", "definition": "Time period during which identifier is/was valid for use.", "min": 0, "max": "1", "base": { "path": "Identifier.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "comments": "If the low element is missing, the meaning is that the low boundary is not known.", "path": "Organization.identifier.period.start", "short": "Starting time with inclusive boundary", "definition": "The start of the period. The boundary is inclusive.", "min": 0, "max": "1", "base": { "path": "Period.start", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ] }, { "comments": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.", "path": "Organization.identifier.period.end", "short": "End time with inclusive boundary, if not ongoing", "definition": "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "min": 0, "max": "1", "base": { "path": "Period.end", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ] }, { "comments": "The reference may be just a text description of the assigner.", "path": "Organization.identifier.assigner", "short": "Organization that issued id (may be just text)", "definition": "Organization that issued/manages the identifier.", "min": 0, "max": "1", "base": { "path": "Identifier.assigner", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ] }, { "comments": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "path": "Organization.identifier.assigner.reference", "short": "Relative, internal or absolute URL reference", "definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "min": 0, "max": "1", "base": { "path": "Reference.reference", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-1" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "comments": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "path": "Organization.identifier.assigner.display", "short": "Text alternative for the resource", "definition": "Plain text narrative that identifies the resource in addition to the resource reference.", "min": 0, "max": "1", "base": { "path": "Reference.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "name": "National Organization ID", "path": "Organization.identifier", "short": "Identifies this organization across multiple systems", "definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.", "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" } ], "condition": [ "org-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XON.10 / XON.3" }, { "identity": "rim", "map": ".scopes[Role](classCode=IDENT)" }, { "identity": "servd", "map": "./Identifiers" }, { "identity": "w5", "map": "id" } ] }, { "comments": "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.", "path": "Organization.identifier.use", "short": "usual | official | temp | secondary (If known)", "definition": "The purpose of this identifier.", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 0, "max": "0", "base": { "path": "Identifier.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "Identifies the purpose for this identifier, if known .", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-use" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "comments": "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.", "path": "Organization.identifier.type", "short": "Description of identifier", "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 0, "max": "0", "base": { "path": "Identifier.type", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "extensible", "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-type" } }, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.", "path": "Organization.identifier.type.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "comments": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.", "path": "Organization.identifier.type.coding.system", "short": "Identity of the terminology system", "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 0, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "comments": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "path": "Organization.identifier.type.coding.version", "short": "Version of the system - if relevant", "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "min": 0, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "path": "Organization.identifier.type.coding.code", "short": "Symbol in syntax defined by the system", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "requirements": "Need to refer to a particular code in the system.", "min": 0, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "path": "Organization.identifier.type.coding.display", "short": "Representation defined by the system", "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 0, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "comments": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "path": "Organization.identifier.type.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ] }, { "comments": "Very often the text is the same as a displayName of one of the codings.", "path": "Organization.identifier.type.text", "short": "Plain text representation of the concept", "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "exampleUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri", "path": "Organization.identifier.system", "short": "The namespace for the identifier", "definition": "Establishes the namespace in which set of possible id values is unique.", "requirements": "There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.", "min": 1, "max": "1", "base": { "path": "Identifier.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "http://fhir.furore.com/NamingSystem/NationalOrganizationIdentifier", "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ] }, { "comments": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.", "exampleString": "123456", "path": "Organization.identifier.value", "short": "The value that is unique", "definition": "The portion of the identifier typically displayed to the user and which is unique within the context of the system.", "min": 1, "max": "1", "base": { "path": "Identifier.value", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ] }, { "path": "Organization.identifier.period", "short": "Time period when id is/was valid for use", "definition": "Time period during which identifier is/was valid for use.", "min": 0, "max": "0", "base": { "path": "Identifier.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "comments": "If the low element is missing, the meaning is that the low boundary is not known.", "path": "Organization.identifier.period.start", "short": "Starting time with inclusive boundary", "definition": "The start of the period. The boundary is inclusive.", "min": 0, "max": "1", "base": { "path": "Period.start", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ] }, { "comments": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.", "path": "Organization.identifier.period.end", "short": "End time with inclusive boundary, if not ongoing", "definition": "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "min": 0, "max": "1", "base": { "path": "Period.end", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ] }, { "comments": "The reference may be just a text description of the assigner.", "path": "Organization.identifier.assigner", "short": "Organization that issued id (may be just text)", "definition": "Organization that issued/manages the identifier.", "min": 0, "max": "0", "base": { "path": "Identifier.assigner", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ] }, { "comments": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "path": "Organization.identifier.assigner.reference", "short": "Relative, internal or absolute URL reference", "definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "min": 0, "max": "1", "base": { "path": "Reference.reference", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-1" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "comments": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "path": "Organization.identifier.assigner.display", "short": "Text alternative for the resource", "definition": "Plain text narrative that identifies the resource in addition to the resource reference.", "min": 0, "max": "1", "base": { "path": "Reference.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "comments": "Default is true.", "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.", "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": 0, "max": "0", "base": { "path": "Organization.active", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "defaultValueBoolean": true, "isModifier": true, "isSummary": true, "mapping": [ { "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." }, { "identity": "w5", "map": "status" } ] }, { "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.", "path": "Organization.type", "short": "Kind of organization", "definition": "The kind of organization that this is.", "requirements": "Need to be able to track the kind of organization that this is - different organization types have different uses.", "min": 0, "max": "0", "base": { "path": "Organization.type", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "example", "description": "Used to categorize the organization", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/organization-type" } }, "mapping": [ { "identity": "v2", "map": "No equivalent in v2" }, { "identity": "rim", "map": ".code" }, { "identity": "servd", "map": "n/a" }, { "identity": "w5", "map": "class" } ] }, { "comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.", "path": "Organization.type.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "comments": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.", "path": "Organization.type.coding.system", "short": "Identity of the terminology system", "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 0, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "comments": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "path": "Organization.type.coding.version", "short": "Version of the system - if relevant", "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "min": 0, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "path": "Organization.type.coding.code", "short": "Symbol in syntax defined by the system", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "requirements": "Need to refer to a particular code in the system.", "min": 0, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "path": "Organization.type.coding.display", "short": "Representation defined by the system", "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 0, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "comments": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "path": "Organization.type.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ] }, { "comments": "Very often the text is the same as a displayName of one of the codings.", "path": "Organization.type.text", "short": "Plain text representation of the concept", "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "path": "Organization.name", "short": "Name used for the organization", "definition": "A name associated with the organization.", "requirements": "Need to use the name as the label of the organization.", "min": 0, "max": "1", "base": { "path": "Organization.name", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "org-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XON.1" }, { "identity": "rim", "map": ".name" }, { "identity": "servd", "map": ".PreferredName/Name" } ] }, { "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.", "path": "Organization.telecom", "short": "A contact detail for the organization", "definition": "A contact detail for the organization.", "requirements": "Human contact for the organization.", "min": 0, "max": "0", "base": { "path": "Organization.telecom", "min": 0, "max": "*" }, "type": [ { "code": "ContactPoint" } ], "condition": [ "org-3" ], "constraint": [ { "key": "org-3", "severity": "error", "human": "The telecom of an organization can never be of use 'home'", "xpath": "count(f:use[@value='home']) = 0" } ], "mapping": [ { "identity": "v2", "map": "ORC-22?" }, { "identity": "rim", "map": ".telecom" }, { "identity": "servd", "map": "./ContactPoints" } ] }, { "path": "Organization.telecom.system", "short": "phone | fax | email | pager | 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" ], "isSummary": true, "binding": { "strength": "required", "description": "Telecommunications form for contact point", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contact-point-system" } }, "mapping": [ { "identity": "v2", "map": "XTN.3" }, { "identity": "rim", "map": "./scheme" }, { "identity": "servd", "map": "./ContactPointType" } ] }, { "comments": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the 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).", "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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.1 (or XTN.12)" }, { "identity": "rim", "map": "./url" }, { "identity": "servd", "map": "./Value" } ] }, { "comments": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.", "path": "Organization.telecom.use", "short": "home | work | temp | old | mobile - purpose of this contact point", "definition": "Identifies the purpose for the contact point.", "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" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "Use of contact point", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contact-point-use" } }, "mapping": [ { "identity": "v2", "map": "XTN.2 - but often indicated by field" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./ContactPointPurpose" } ] }, { "comments": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.", "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. Contacts are ranked with lower values coming before higher values.", "min": 0, "max": "1", "base": { "path": "ContactPoint.rank", "min": 0, "max": "1" }, "type": [ { "code": "positiveInt" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ] }, { "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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "./useablePeriod[type=\"IVL\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "comments": "If the low element is missing, the meaning is that the low boundary is not known.", "path": "Organization.telecom.period.start", "short": "Starting time with inclusive boundary", "definition": "The start of the period. The boundary is inclusive.", "min": 0, "max": "1", "base": { "path": "Period.start", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ] }, { "comments": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.", "path": "Organization.telecom.period.end", "short": "End time with inclusive boundary, if not ongoing", "definition": "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "min": 0, "max": "1", "base": { "path": "Period.end", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ] }, { "comments": "Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used.", "path": "Organization.address", "short": "An address for the organization", "definition": "An address for the organization.", "requirements": "May need to keep track of the organization's addresses for contacting, billing or reporting requirements.", "min": 0, "max": "0", "base": { "path": "Organization.address", "min": 0, "max": "*" }, "type": [ { "code": "Address" } ], "condition": [ "org-2" ], "constraint": [ { "key": "org-2", "severity": "error", "human": "An address of an organization can never be of use 'home'", "xpath": "count(f:use[@value='home']) = 0" } ], "mapping": [ { "identity": "v2", "map": "ORC-23?" }, { "identity": "rim", "map": ".address" }, { "identity": "servd", "map": "./PrimaryAddress and ./OtherAddresses" } ] }, { "comments": "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.", "exampleCode": "home", "path": "Organization.address.use", "short": "home | work | temp | old - purpose of this address", "definition": "The purpose of this address.", "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" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "The use of an address", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/address-use" } }, "mapping": [ { "identity": "v2", "map": "XAD.7" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./AddressPurpose" } ] }, { "exampleCode": "both", "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.", "min": 0, "max": "1", "base": { "path": "Address.type", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "The type of an address (physical / postal)", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/address-type" } }, "mapping": [ { "identity": "v2", "map": "XAD.18" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "vcard", "map": "address type parameter" } ] }, { "comments": "Can provide both a text representation and parts.", "exampleString": "137 Nowhere Street, Erewhon 9132", "path": "Organization.address.text", "short": "Text representation of the address", "definition": "A full text representation of the address.", "requirements": "A renderable, unencoded form.", "min": 0, "max": "1", "base": { "path": "Address.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "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" } ] }, { "exampleString": "137 Nowhere Street", "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.", "requirements": "home | work | temp | old - purpose of this address.", "min": 0, "max": "*", "base": { "path": "Address.line", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "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)" } ] }, { "exampleString": "Erewhon", "path": "Organization.address.city", "short": "Name of city, town etc.", "definition": "The name of the city, town, village or other community or delivery center.", "alias": [ "Municpality" ], "min": 0, "max": "1", "base": { "path": "Address.city", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "vcard", "map": "locality" }, { "identity": "servd", "map": "./Jurisdiction" } ] }, { "comments": "District is sometimes known as county, but in some regions 'county' in used in place of city (municipality), so county name should be conveyed in city instead.", "exampleString": "Madison", "path": "Organization.address.district", "short": "District name (aka county)", "definition": "The name of the administrative area (county).", "alias": [ "County" ], "min": 0, "max": "1", "base": { "path": "Address.district", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.9" }, { "identity": "rim", "map": "AD.part[parttype = CNT | CPA]" } ] }, { "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 (i.e. US 2 letter state codes).", "alias": [ "Province", "Territory" ], "min": 0, "max": "1", "base": { "path": "Address.state", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "vcard", "map": "region" }, { "identity": "servd", "map": "./Region" } ] }, { "exampleString": "9132", "path": "Organization.address.postalCode", "short": "Postal code for area", "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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "vcard", "map": "code" }, { "identity": "servd", "map": "./PostalIdentificationCode" } ] }, { "comments": "ISO 3166 3 letter codes can be used in place of a full country name.", "path": "Organization.address.country", "short": "Country (can be ISO 3166 3 letter code)", "definition": "Country - a nation as commonly understood or generally accepted.", "min": 0, "max": "1", "base": { "path": "Address.country", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "vcard", "map": "country" }, { "identity": "servd", "map": "./Country" } ] }, { "examplePeriod": { "start": "2010-03-23", "end": "2010-07-01" }, "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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.12 / XAD.13 + XAD.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "comments": "If the low element is missing, the meaning is that the low boundary is not known.", "path": "Organization.address.period.start", "short": "Starting time with inclusive boundary", "definition": "The start of the period. The boundary is inclusive.", "min": 0, "max": "1", "base": { "path": "Period.start", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ] }, { "comments": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.", "path": "Organization.address.period.end", "short": "End time with inclusive boundary, if not ongoing", "definition": "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "min": 0, "max": "1", "base": { "path": "Period.end", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ] }, { "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": "0", "base": { "path": "Organization.partOf", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "No equivalent in HL7 v2" }, { "identity": "rim", "map": ".playedBy[classCode=Part].scoper" }, { "identity": "servd", "map": "n/a" } ] }, { "comments": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "path": "Organization.partOf.reference", "short": "Relative, internal or absolute URL reference", "definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "min": 0, "max": "1", "base": { "path": "Reference.reference", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-1" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "comments": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "path": "Organization.partOf.display", "short": "Text alternative for the resource", "definition": "Plain text narrative that identifies the resource in addition to the resource reference.", "min": 0, "max": "1", "base": { "path": "Reference.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "comments": "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.", "path": "Organization.contact", "short": "Contact for the organization for a certain purpose", "definition": "Contact for the organization for a certain purpose.", "requirements": "Need to keep track of assigned contact points within bigger organization.", "min": 0, "max": "0", "base": { "path": "Organization.contact", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "mapping": [ { "identity": "rim", "map": ".contactParty" } ] }, { "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 level of simplicity for everyone.", "path": "Organization.contact.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 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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "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" } ], "binding": { "strength": "extensible", "description": "The purpose for which you would contact a contact party", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contactentity-type" } }, "mapping": [ { "identity": "rim", "map": "./type" } ] }, { "comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.", "path": "Organization.contact.purpose.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "comments": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.", "path": "Organization.contact.purpose.coding.system", "short": "Identity of the terminology system", "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 0, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "comments": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "path": "Organization.contact.purpose.coding.version", "short": "Version of the system - if relevant", "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "min": 0, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "path": "Organization.contact.purpose.coding.code", "short": "Symbol in syntax defined by the system", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "requirements": "Need to refer to a particular code in the system.", "min": 0, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "path": "Organization.contact.purpose.coding.display", "short": "Representation defined by the system", "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 0, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "comments": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "path": "Organization.contact.purpose.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ] }, { "comments": "Very often the text is the same as a displayName of one of the codings.", "path": "Organization.contact.purpose.text", "short": "Plain text representation of the concept", "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "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" } ], "mapping": [ { "identity": "v2", "map": "PID-5, PID-9" }, { "identity": "rim", "map": "./name" } ] }, { "comments": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.", "path": "Organization.contact.name.use", "short": "usual | official | temp | nickname | anonymous | old | maiden", "definition": "Identifies the purpose for this name.", "requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.", "min": 0, "max": "1", "base": { "path": "HumanName.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "The use of a human name", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/name-use" } }, "mapping": [ { "identity": "v2", "map": "XPN.7, but often indicated by which field contains the name" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./NamePurpose" } ] }, { "comments": "Can provide both a text representation and structured parts.", "path": "Organization.contact.name.text", "short": "Text representation of the full name", "definition": "A full text representation of the name.", "requirements": "A renderable, unencoded form.", "min": 0, "max": "1", "base": { "path": "HumanName.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "implied by XPN.11" }, { "identity": "rim", "map": "./formatted" } ] }, { "comments": "For family name, hyphenated names such as \"Smith-Jones\" are a single name, but names with spaces such as \"Smith Jones\" are broken into multiple parts.", "path": "Organization.contact.name.family", "short": "Family name (often called 'Surname')", "definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.", "alias": [ "surname" ], "min": 0, "max": "*", "base": { "path": "HumanName.family", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.1" }, { "identity": "rim", "map": "./part[partType = FAM]" }, { "identity": "servd", "map": "./FamilyName" } ] }, { "comments": "If only initials are recorded, they may be used in place of the full name. Not called \"first name\" since given names do not always come first.", "path": "Organization.contact.name.given", "short": "Given names (not always 'first'). Includes middle names", "definition": "Given name.", "alias": [ "first name", "middle name" ], "min": 0, "max": "*", "base": { "path": "HumanName.given", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.2 + XPN.3" }, { "identity": "rim", "map": "./part[partType = GIV]" }, { "identity": "servd", "map": "./GivenNames" } ] }, { "path": "Organization.contact.name.prefix", "short": "Parts that come before the name", "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.", "min": 0, "max": "*", "base": { "path": "HumanName.prefix", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.5" }, { "identity": "rim", "map": "./part[partType = PFX]" }, { "identity": "servd", "map": "./TitleCode" } ] }, { "path": "Organization.contact.name.suffix", "short": "Parts that come after the name", "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.", "min": 0, "max": "*", "base": { "path": "HumanName.suffix", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN/4" }, { "identity": "rim", "map": "./part[partType = SFX]" } ] }, { "path": "Organization.contact.name.period", "short": "Time period when name was/is in use", "definition": "Indicates the period of time when this name was valid for the named person.", "requirements": "Allows names to be placed in historical context.", "min": 0, "max": "1", "base": { "path": "HumanName.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.13 + XPN.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "comments": "If the low element is missing, the meaning is that the low boundary is not known.", "path": "Organization.contact.name.period.start", "short": "Starting time with inclusive boundary", "definition": "The start of the period. The boundary is inclusive.", "min": 0, "max": "1", "base": { "path": "Period.start", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ] }, { "comments": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.", "path": "Organization.contact.name.period.end", "short": "End time with inclusive boundary, if not ongoing", "definition": "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "min": 0, "max": "1", "base": { "path": "Period.end", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ] }, { "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" } ], "mapping": [ { "identity": "v2", "map": "PID-13, PID-14" }, { "identity": "rim", "map": "./telecom" } ] }, { "path": "Organization.contact.telecom.system", "short": "phone | fax | email | pager | 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" ], "isSummary": true, "binding": { "strength": "required", "description": "Telecommunications form for contact point", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contact-point-system" } }, "mapping": [ { "identity": "v2", "map": "XTN.3" }, { "identity": "rim", "map": "./scheme" }, { "identity": "servd", "map": "./ContactPointType" } ] }, { "comments": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.", "path": "Organization.contact.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).", "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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.1 (or XTN.12)" }, { "identity": "rim", "map": "./url" }, { "identity": "servd", "map": "./Value" } ] }, { "comments": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.", "path": "Organization.contact.telecom.use", "short": "home | work | temp | old | mobile - purpose of this contact point", "definition": "Identifies the purpose for the contact point.", "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" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "Use of contact point", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contact-point-use" } }, "mapping": [ { "identity": "v2", "map": "XTN.2 - but often indicated by field" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./ContactPointPurpose" } ] }, { "comments": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.", "path": "Organization.contact.telecom.rank", "short": "Specify preferred order of use (1 = highest)", "definition": "Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.", "min": 0, "max": "1", "base": { "path": "ContactPoint.rank", "min": 0, "max": "1" }, "type": [ { "code": "positiveInt" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ] }, { "path": "Organization.contact.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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "./useablePeriod[type=\"IVL\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "comments": "If the low element is missing, the meaning is that the low boundary is not known.", "path": "Organization.contact.telecom.period.start", "short": "Starting time with inclusive boundary", "definition": "The start of the period. The boundary is inclusive.", "min": 0, "max": "1", "base": { "path": "Period.start", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ] }, { "comments": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.", "path": "Organization.contact.telecom.period.end", "short": "End time with inclusive boundary, if not ongoing", "definition": "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "min": 0, "max": "1", "base": { "path": "Period.end", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ] }, { "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" } ], "mapping": [ { "identity": "v2", "map": "PID-11" }, { "identity": "rim", "map": "./addr" } ] }, { "comments": "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.", "exampleCode": "home", "path": "Organization.contact.address.use", "short": "home | work | temp | old - purpose of this address", "definition": "The purpose of this address.", "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" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "The use of an address", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/address-use" } }, "mapping": [ { "identity": "v2", "map": "XAD.7" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./AddressPurpose" } ] }, { "exampleCode": "both", "path": "Organization.contact.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.", "min": 0, "max": "1", "base": { "path": "Address.type", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "isSummary": true, "binding": { "strength": "required", "description": "The type of an address (physical / postal)", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/address-type" } }, "mapping": [ { "identity": "v2", "map": "XAD.18" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "vcard", "map": "address type parameter" } ] }, { "comments": "Can provide both a text representation and parts.", "exampleString": "137 Nowhere Street, Erewhon 9132", "path": "Organization.contact.address.text", "short": "Text representation of the address", "definition": "A full text representation of the address.", "requirements": "A renderable, unencoded form.", "min": 0, "max": "1", "base": { "path": "Address.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "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" } ] }, { "exampleString": "137 Nowhere Street", "path": "Organization.contact.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.", "requirements": "home | work | temp | old - purpose of this address.", "min": 0, "max": "*", "base": { "path": "Address.line", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "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)" } ] }, { "exampleString": "Erewhon", "path": "Organization.contact.address.city", "short": "Name of city, town etc.", "definition": "The name of the city, town, village or other community or delivery center.", "alias": [ "Municpality" ], "min": 0, "max": "1", "base": { "path": "Address.city", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "vcard", "map": "locality" }, { "identity": "servd", "map": "./Jurisdiction" } ] }, { "comments": "District is sometimes known as county, but in some regions 'county' in used in place of city (municipality), so county name should be conveyed in city instead.", "exampleString": "Madison", "path": "Organization.contact.address.district", "short": "District name (aka county)", "definition": "The name of the administrative area (county).", "alias": [ "County" ], "min": 0, "max": "1", "base": { "path": "Address.district", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.9" }, { "identity": "rim", "map": "AD.part[parttype = CNT | CPA]" } ] }, { "path": "Organization.contact.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 (i.e. US 2 letter state codes).", "alias": [ "Province", "Territory" ], "min": 0, "max": "1", "base": { "path": "Address.state", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "vcard", "map": "region" }, { "identity": "servd", "map": "./Region" } ] }, { "exampleString": "9132", "path": "Organization.contact.address.postalCode", "short": "Postal code for area", "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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "vcard", "map": "code" }, { "identity": "servd", "map": "./PostalIdentificationCode" } ] }, { "comments": "ISO 3166 3 letter codes can be used in place of a full country name.", "path": "Organization.contact.address.country", "short": "Country (can be ISO 3166 3 letter code)", "definition": "Country - a nation as commonly understood or generally accepted.", "min": 0, "max": "1", "base": { "path": "Address.country", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "vcard", "map": "country" }, { "identity": "servd", "map": "./Country" } ] }, { "examplePeriod": { "start": "2010-03-23", "end": "2010-07-01" }, "path": "Organization.contact.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" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.12 / XAD.13 + XAD.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "comments": "If the low element is missing, the meaning is that the low boundary is not known.", "path": "Organization.contact.address.period.start", "short": "Starting time with inclusive boundary", "definition": "The start of the period. The boundary is inclusive.", "min": 0, "max": "1", "base": { "path": "Period.start", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.1" }, { "identity": "rim", "map": "./low" } ] }, { "comments": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.", "path": "Organization.contact.address.period.end", "short": "End time with inclusive boundary, if not ongoing", "definition": "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", "min": 0, "max": "1", "base": { "path": "Period.end", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing", "condition": [ "per-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "DR.2" }, { "identity": "rim", "map": "./high" } ] } ] }, "differential": { "element": [ { "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, etc.", "min": 0, "max": "*", "base": { "path": "Organization", "min": 0, "max": "*" }, "type": [ { "code": "Organization" } ], "constraint": [ { "key": "org-1", "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" } ], "mapping": [ { "identity": "v2", "map": "(also see master files messages)" }, { "identity": "rim", "map": "Organization(classCode=ORG, determinerCode=INST)" }, { "identity": "servd", "map": "Organization" }, { "identity": "w5", "map": "administrative.group" } ] }, { "path": "Organization.identifier", "slicing": { "rules": "openAtEnd" }, "short": "Identifies this organization across multiple systems", "definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.", "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" } ], "condition": [ "org-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XON.10 / XON.3" }, { "identity": "rim", "map": ".scopes[Role](classCode=IDENT)" }, { "identity": "servd", "map": "./Identifiers" }, { "identity": "w5", "map": "id" } ] }, { "name": "National Organization ID", "path": "Organization.identifier", "short": "Identifies this organization across multiple systems", "definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.", "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" } ], "condition": [ "org-1" ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XON.10 / XON.3" }, { "identity": "rim", "map": ".scopes[Role](classCode=IDENT)" }, { "identity": "servd", "map": "./Identifiers" }, { "identity": "w5", "map": "id" } ] }, { "comments": "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.", "path": "Organization.identifier.use", "short": "usual | official | temp | secondary (If known)", "definition": "The purpose of this identifier.", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 0, "max": "0", "base": { "path": "Identifier.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "Identifies the purpose for this identifier, if known .", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-use" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "comments": "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.", "path": "Organization.identifier.type", "short": "Description of identifier", "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 0, "max": "0", "base": { "path": "Identifier.type", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "extensible", "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-type" } }, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "exampleUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri", "path": "Organization.identifier.system", "short": "The namespace for the identifier", "definition": "Establishes the namespace in which set of possible id values is unique.", "requirements": "There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.", "min": 1, "max": "1", "base": { "path": "Identifier.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "http://fhir.furore.com/NamingSystem/NationalOrganizationIdentifier", "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ] }, { "comments": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.", "exampleString": "123456", "path": "Organization.identifier.value", "short": "The value that is unique", "definition": "The portion of the identifier typically displayed to the user and which is unique within the context of the system.", "min": 1, "max": "1", "base": { "path": "Identifier.value", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ] }, { "path": "Organization.identifier.period", "short": "Time period when id is/was valid for use", "definition": "Time period during which identifier is/was valid for use.", "min": 0, "max": "0", "base": { "path": "Identifier.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "comments": "The reference may be just a text description of the assigner.", "path": "Organization.identifier.assigner", "short": "Organization that issued id (may be just text)", "definition": "Organization that issued/manages the identifier.", "min": 0, "max": "0", "base": { "path": "Identifier.assigner", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ] }, { "comments": "Default is true.", "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.", "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": 0, "max": "0", "base": { "path": "Organization.active", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "defaultValueBoolean": true, "isModifier": true, "isSummary": true, "mapping": [ { "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." }, { "identity": "w5", "map": "status" } ] }, { "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.", "path": "Organization.type", "short": "Kind of organization", "definition": "The kind of organization that this is.", "requirements": "Need to be able to track the kind of organization that this is - different organization types have different uses.", "min": 0, "max": "0", "base": { "path": "Organization.type", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "strength": "example", "description": "Used to categorize the organization", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/organization-type" } }, "mapping": [ { "identity": "v2", "map": "No equivalent in v2" }, { "identity": "rim", "map": ".code" }, { "identity": "servd", "map": "n/a" }, { "identity": "w5", "map": "class" } ] }, { "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.", "path": "Organization.telecom", "short": "A contact detail for the organization", "definition": "A contact detail for the organization.", "requirements": "Human contact for the organization.", "min": 0, "max": "0", "base": { "path": "Organization.telecom", "min": 0, "max": "*" }, "type": [ { "code": "ContactPoint" } ], "condition": [ "org-3" ], "constraint": [ { "key": "org-3", "severity": "error", "human": "The telecom of an organization can never be of use 'home'", "xpath": "count(f:use[@value='home']) = 0" } ], "mapping": [ { "identity": "v2", "map": "ORC-22?" }, { "identity": "rim", "map": ".telecom" }, { "identity": "servd", "map": "./ContactPoints" } ] }, { "comments": "Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used.", "path": "Organization.address", "short": "An address for the organization", "definition": "An address for the organization.", "requirements": "May need to keep track of the organization's addresses for contacting, billing or reporting requirements.", "min": 0, "max": "0", "base": { "path": "Organization.address", "min": 0, "max": "*" }, "type": [ { "code": "Address" } ], "condition": [ "org-2" ], "constraint": [ { "key": "org-2", "severity": "error", "human": "An address of an organization can never be of use 'home'", "xpath": "count(f:use[@value='home']) = 0" } ], "mapping": [ { "identity": "v2", "map": "ORC-23?" }, { "identity": "rim", "map": ".address" }, { "identity": "servd", "map": "./PrimaryAddress and ./OtherAddresses" } ] }, { "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": "0", "base": { "path": "Organization.partOf", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "No equivalent in HL7 v2" }, { "identity": "rim", "map": ".playedBy[classCode=Part].scoper" }, { "identity": "servd", "map": "n/a" } ] }, { "comments": "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.", "path": "Organization.contact", "short": "Contact for the organization for a certain purpose", "definition": "Contact for the organization for a certain purpose.", "requirements": "Need to keep track of assigned contact points within bigger organization.", "min": 0, "max": "0", "base": { "path": "Organization.contact", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "mapping": [ { "identity": "rim", "map": ".contactParty" } ] } ] } }