{
"description": "The HSDSOrganization resource is a formal or informal grouping of people or organizations set up to assist people in coping with issues related to various social issues, including but not limited to: adequate housing, substance abuse, domestic conflict, mental health and/or personal/familial problems.\\nGuidance: When the contact is a department name, rather than a human (e.g., patient help line), include a blank family and given name, and provide the department name in contact.name.text.",
"_filename": "StructureDefinition-hsds-Organization.json",
"package_name": "hl7.fhir.us.hsds",
"date": "2022-12-08T20:20:19+00:00",
"derivation": "constraint",
"publisher": "HL7 Human and Social Services Work Group",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "HSDSOrganization",
"mapping": [ {
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD",
"identity": "servd"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "HSDS",
"name": "HSDS",
"comment": "This section describes the way HSDS version 2.0.1 elements are mapped from HSDS tables to the FHIR Organization profile. The left hand column represents the FHIR Organization element name, the right column contains the HSDS table.element followed by its description within parenthesis. Comments related to the mapping may follow the HSDS element description.",
"identity": "hsds"
} ],
"abstract": false,
"type": "Organization",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "HSDSOrganization",
"package_version": "1.0.0-ballot",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
}, {
"key": "org-1",
"human": "The organization SHALL at least have a name or an identifier, and possibly more than one",
"xpath": "count(f:identifier | f:name) > 0",
"source": "http://hl7.org/fhir/StructureDefinition/Organization",
"severity": "error",
"expression": "(identifier.count() + name.count()) > 0"
} ],
"path": "Organization",
"min": 0,
"definition": "A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.",
"isModifier": false,
"short": "A grouping of people or organizations with a common purpose",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "(also see master files messages)",
"identity": "v2"
}, {
"map": "Organization(classCode=ORG, determinerCode=INST)",
"identity": "rim"
}, {
"map": "Organization",
"identity": "servd"
} ],
"mustSupport": false,
"max": "*",
"id": "Organization",
"base": {
"max": "*",
"min": 0,
"path": "Organization"
},
"isSummary": false
}, {
"path": "Organization.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"mapping": [ {
"map": "organization.id Note: Each organization must have a unique system identifier in the source system.",
"identity": "hsds"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"max": "1",
"id": "Organization.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"mapping": [ {
"map": "Note: The HSDS metadata table contains a record of the changes that have been made to the data in order to maintain provenance information.",
"identity": "hsds"
} ],
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Organization.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Organization.meta.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "metadata.id Note: This data element may be ignored as having the id for the date metadata isn't essential. If populated, it should be id corresponding to the latest action date for given organization as described below.",
"identity": "hsds"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Organization.meta.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.meta.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Organization.meta.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.meta.versionId",
"min": 0,
"definition": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.",
"isModifier": false,
"short": "Version specific identifier",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Organization.meta.versionId",
"comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.versionId"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.meta.lastUpdated",
"min": 1,
"definition": "When the resource last changed - e.g. when the version changed.",
"isModifier": false,
"short": "When the resource version last changed",
"mapping": [ {
"map": "metadata.last_action_date Note: The date when data was changed. Since there may be more than one metadata record for each organization, the latest max(last_action_date) needs to be used from metadata where (FHIR) Organization.id = (HSDS) metadata.resource_id.",
"identity": "hsds"
} ],
"type": [ {
"code": "instant"
} ],
"max": "1",
"id": "Organization.meta.lastUpdated",
"comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.lastUpdated"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.meta.source",
"min": 0,
"definition": "A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.",
"isModifier": false,
"short": "Identifies where the resource comes from",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Organization.meta.source",
"comment": "In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. \n\nThis element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.source"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.meta.profile",
"min": 0,
"definition": "A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).",
"isModifier": false,
"short": "Profiles this resource claims to conform to",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"max": "*",
"id": "Organization.meta.profile",
"comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.profile"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.meta.security",
"min": 0,
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"isModifier": false,
"short": "Security Labels applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/security-labels",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System."
},
"max": "*",
"id": "Organization.meta.security",
"comment": "The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.security"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.meta.tag",
"min": 0,
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"isModifier": false,
"short": "Tags applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/common-tags",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
} ],
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"."
},
"max": "*",
"id": "Organization.meta.tag",
"comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.tag"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Organization.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This data element in FHIR is referring to language for the resource context and not the language for the communication for given service or location.",
"identity": "hsds"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "1",
"id": "Organization.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This DomainResource.text is meant for textual summary of the resource so organization description is mapped to the org-description extension added by Plan-Net profile.",
"identity": "hsds"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Organization.text",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "Organization.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Organization.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Organization.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.extension",
"min": 0,
"definition": "An extension to add qualifications for an organization (e.g. accreditation) or practitionerRole (e.g. registered to prescribe controlled substances).",
"isModifier": false,
"short": "Qualification",
"mapping": [ {
"map": "extension[qualification]:code.url = 'code' extension[qualification]:code.valueCodeableConcept.text = service.accreditations \nNote: This is a GAP in HSDS that can be resolved by having qualifications collected at the organization level. As a workaround, suggested mapping uses the unique set of accreditations from service and concatenated for the organization level as described below.",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/qualification" ]
} ],
"mustSupport": true,
"sliceName": "qualification",
"max": "*",
"id": "Organization.extension:qualification",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.extension",
"min": 0,
"definition": "An extension to provide a human-readable description of an organization.",
"isModifier": false,
"short": "Org Description",
"mapping": [ {
"map": "organization.description Note: This Plan-Net profile added this extension for organization description as opposed to using DomainResource.text data element which is meant for textual summary of the resource.",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/org-description" ]
} ],
"mustSupport": true,
"sliceName": "org-description",
"max": "1",
"id": "Organization.extension:org-description",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Organization.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.identifier",
"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,
"definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"isModifier": false,
"short": "Identifies this organization across multiple systems",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "XON.10 / XON.3",
"identity": "v2"
}, {
"map": ".scopes[Role](classCode=IDENT)",
"identity": "rim"
}, {
"map": "./Identifiers",
"identity": "servd"
}, {
"map": "n/a",
"identity": "servd"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "pattern"
} ]
},
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "*",
"id": "Organization.identifier",
"condition": [ "org-1" ],
"comment": "NPI preferred.",
"base": {
"max": "*",
"min": 0,
"path": "Organization.identifier"
},
"isSummary": true
}, {
"path": "Organization.identifier.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This data element may be ignored as having the id for the identifier record isn't essential and is not available in HSDS since the tax ID is directly on the organization table.",
"identity": "hsds"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Organization.identifier.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.identifier.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Organization.identifier.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.identifier.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary | old (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
}, {
"map": "Fixed value = 'official' Note: Since the organization business identifier in HSDS is organization.tax id which is used for official purpose, this element is to be set with a fixed value 'official' drawn from the code system IdentifierUse http://hl7.org/fhir/identifier-use.",
"identity": "hsds"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known ."
},
"max": "1",
"id": "Organization.identifier.use",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.identifier.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"isModifier": false,
"short": "Description of identifier",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
}, {
"map": "Fixed value = 'TAX' Note: Since the organization business identifier in HSDS is organization.tax id which is used for the tax, this element is to be set with a fixed value 'TAX' drawn from the IdentifierType code system – http://terminology.hl7.org/CodeSystem/v2-0203 [an HL7-defined code system of concepts specifying type of identifier].",
"identity": "hsds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."
},
"max": "1",
"id": "Organization.identifier.type",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.identifier.system",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 0,
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"isModifier": false,
"short": "The namespace for the identifier value",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
}, {
"map": "Fixed value = 'urn:us:gov:irs' Note: Since the organization business identifier in HSDS is organization.tax id which is issued by IRS, this element is to be set with a fixed value with IRS URN.",
"identity": "hsds"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.identifier.system",
"comment": "Identifier.system is always case sensitive.",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.identifier.value",
"min": 0,
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"isModifier": false,
"short": "The value that is unique",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
}, {
"map": "organization.tax_id Note: This is the only business identifier in HSDS at this time.",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.identifier.value",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"example": [ {
"label": "General",
"valueString": "123456"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.identifier.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"isModifier": false,
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
}, {
"map": "organization.year_incorporated Note: HSDS organization.year_incorporated may not always be the same as when the TAX ID was issued (especially if a company merged or split). Technically year_incorporated is a GAP in FHIR and should be added as an extension. Also the effective date of the identifier (mapped to period here) is GAP in HSDS. But until both of those GAPs are addressed, the above mapping is proposed as a work around.",
"identity": "hsds"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Organization.identifier.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.identifier.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"isModifier": false,
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
}, {
"map": "Fixed value = 'www.irs.gov' Note: This is GAP in HSDS but it can be implicitly inferred. Since the organization business identifier in HSDS is organization.tax id which is issued by IRS, this element is to be set with a fixed value with IRS website link as a reference.",
"identity": "hsds"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "Organization.identifier.assigner",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.identifier",
"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,
"definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"isModifier": false,
"short": "National Provider Identifier (NPI)",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "XON.10 / XON.3",
"identity": "v2"
}, {
"map": ".scopes[Role](classCode=IDENT)",
"identity": "rim"
}, {
"map": "./Identifiers",
"identity": "servd"
}, {
"map": "n/a",
"identity": "servd"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"sliceName": "NPI",
"patternIdentifier": {
"system": "http://hl7.org/fhir/sid/us-npi"
},
"max": "1",
"id": "Organization.identifier:NPI",
"condition": [ "org-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Organization.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.identifier",
"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,
"definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"isModifier": false,
"short": "Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "XON.10 / XON.3",
"identity": "v2"
}, {
"map": ".scopes[Role](classCode=IDENT)",
"identity": "rim"
}, {
"map": "./Identifiers",
"identity": "servd"
}, {
"map": "n/a",
"identity": "servd"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"sliceName": "CLIA",
"patternIdentifier": {
"system": "urn:oid:2.16.840.1.113883.4.7"
},
"max": "1",
"id": "Organization.identifier:CLIA",
"condition": [ "org-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Organization.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.active",
"requirements": "Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.",
"min": 1,
"definition": "Whether the organization's record is still in active use.",
"isModifier": true,
"short": "Whether the organization's record is still in active use",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "No equivalent in HL7 v2",
"identity": "v2"
}, {
"map": ".status",
"identity": "rim"
}, {
"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": "servd"
}, {
"map": "Fixed value = 'true' Note: HSDS organization does not have a status but this is required in FHIR so fixed value is proposed to indicate that organization is active.",
"identity": "hsds"
} ],
"type": [ {
"code": "boolean"
} ],
"patternBoolean": true,
"mustSupport": true,
"meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element",
"max": "1",
"id": "Organization.active",
"comment": "This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.\n\nThis element is labeled as a modifier because it may be used to mark that the resource was created in error.",
"base": {
"max": "1",
"min": 0,
"path": "Organization.active"
},
"isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.type",
"requirements": "Need to be able to track the kind of organization that this is - different organization types have different uses.",
"min": 1,
"definition": "The kind(s) of organization that this is.",
"isModifier": false,
"short": "Kind of organization",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
}, {
"map": "No equivalent in v2",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "n/a",
"identity": "servd"
}, {
"map": "Fixed values: type.code = 'atyprv' and type.system = 'http://hl7.org/fhir/us/DaVinci-pdex-plan-net/ValueSet/OrgTypeVS' Note: This is a GAP in HSDS but required per Plan-Net profile. Among the allowable codes, 'atyprv' is proposed to represent 'Providers that do not provide healthcare' as the most appropriate for the human services providers.",
"identity": "hsds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/OrgTypeVS"
},
"max": "*",
"id": "Organization.type",
"comment": "Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes\n\nWhen considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.\n\nWe expect that some jurisdictions will profile this optionality to be a single cardinality.",
"patternCodeableConcept": {
"coding": [ {
"code": "atyprv",
"system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrgTypeCS"
} ]
},
"base": {
"max": "*",
"min": 0,
"path": "Organization.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.name",
"requirements": "Need to use the name as the label of the organization.",
"min": 1,
"definition": "A name associated with the organization.",
"isModifier": false,
"short": "Name used for the organization",
"mapping": [ {
"map": "XON.1",
"identity": "v2"
}, {
"map": ".name",
"identity": "rim"
}, {
"map": ".PreferredName/Name",
"identity": "servd"
}, {
"map": "./PrimaryAddress and ./OtherAddresses",
"identity": "servd"
}, {
"map": "organization.name",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.name",
"condition": [ "org-1" ],
"comment": "If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.",
"base": {
"max": "1",
"min": 0,
"path": "Organization.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.alias",
"requirements": "Over time locations and organizations go through many changes and can be known by different names.\n\nFor searching knowing previous names that the organization was known by can be very useful.",
"min": 0,
"definition": "A list of alternate names that the organization is known as, or was known as in the past.",
"isModifier": false,
"short": "A list of alternate names that the organization is known as, or was known as in the past",
"mapping": [ {
"map": ".name",
"identity": "rim"
}, {
"map": "organization.alternate_name Note: Since there is only one alternate name in HSDS but the alias is an array (list) in FHIR, this will map to the first occurrence of the array.",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Organization.alias",
"comment": "There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.",
"base": {
"max": "*",
"min": 0,
"path": "Organization.alias"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "org-3",
"human": "The telecom of an organization can never be of use 'home'",
"xpath": "count(f:use[@value='home']) = 0",
"source": "http://hl7.org/fhir/StructureDefinition/Organization",
"severity": "error",
"expression": "where(use = 'home').empty()"
} ],
"path": "Organization.telecom",
"requirements": "Human contact for the organization.",
"min": 0,
"definition": "A contact detail for the organization.",
"isModifier": false,
"short": "A contact detail for the organization",
"mapping": [ {
"map": "ORC-22?",
"identity": "v2"
}, {
"map": ".telecom",
"identity": "rim"
}, {
"map": "./ContactPoints",
"identity": "servd"
}, {
"map": "Note: This FHIR structure contains contact details of the organization using the ContactPoint datatype (Details for all kinds of technology-mediated contact points for a person or organization, including telephone, email, etc.).",
"identity": "hsds"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"mustSupport": true,
"max": "*",
"id": "Organization.telecom",
"condition": [ "org-3" ],
"comment": "The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.",
"base": {
"max": "*",
"min": 0,
"path": "Organization.telecom"
},
"isSummary": false
}, {
"path": "Organization.telecom.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This data element may be ignored as having the id for the telecom record isn't essential and not always available in the HSDS (e.g. phone id is available but there is no separate id for email or website URL).",
"identity": "hsds"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Organization.telecom.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.telecom.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Organization.telecom.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.telecom.extension",
"min": 0,
"definition": "An extension representing the days and times a contact point is available",
"isModifier": false,
"short": "Contactpoint Availabletime",
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS. This FHIR extension is added by Plan-Net profile and represents available hours for the telecom (e.g. customer service phone hours from 8AM-6PM M-F). There is no equivalent mapping to this data element in HSDS since the HSDS schedule table contains details of when a service or location is open, and is not a phone line associated with an organization.",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime" ]
} ],
"mustSupport": true,
"sliceName": "contactpoint-availabletime",
"max": "*",
"id": "Organization.telecom.extension:contactpoint-availabletime",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.telecom.extension",
"min": 0,
"definition": "A reference to an alternative point of contact (plannet-PractitionerRole, plannet-Organization, plannet-OrganizationAffiliation, or plannet-Location) for this organization",
"isModifier": false,
"short": "Via Intermediary",
"mapping": [ {
"map": "No Source. Note: This is GAP in HSDS. This FHIR extension added by Plan-Net profile represents a reference to an alternative point of contact. HSDS does not have the source data to represent 'intermediary' as that implies some sort of organizational relationship.",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary" ]
} ],
"mustSupport": true,
"sliceName": "via-intermediary",
"max": "*",
"id": "Organization.telecom.extension:via-intermediary",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.telecom.system",
"min": 0,
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"isModifier": false,
"short": "phone | fax | email | pager | url | sms | other",
"mapping": [ {
"map": "XTN.3",
"identity": "v2"
}, {
"map": "./scheme",
"identity": "rim"
}, {
"map": "./ContactPointType",
"identity": "servd"
}, {
"map": "For Phone: \n if phone.type = 'voice' then system = 'phone' \n if phone.type = 'cell' then system = 'phone' \n if phone.type = 'fax' then system = 'fax' \n if phone.type = 'pager' then system = 'pager' \n if phone.type = 'text' then system = 'sms' \n if phone.type = 'textphone' then system = 'sms' \n if phone.type = 'video' then system = 'other' \nFor Email:\n Fixed value = 'email' \nFor Website URL:\n Fixed value = 'url' \nNote: There are multiple sources in HSDS for the telecom in FHIR so the system will be populated based on phone.type mapping or fixed value of 'email' or 'url' depending on the data populated. Drawn from the ContactPointSystem value set [http://hl7.org/fhir/ValueSet/contact-point-system]",
"identity": "hsds"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointSystem"
} ],
"description": "Telecommunications form for contact point."
},
"max": "1",
"id": "Organization.telecom.system",
"condition": [ "cpt-2" ],
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.telecom.value",
"requirements": "Need to support legacy numbers that are not in a tightly controlled format.",
"min": 0,
"definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"isModifier": false,
"short": "The actual contact point details",
"mapping": [ {
"map": "XTN.1 (or XTN.12)",
"identity": "v2"
}, {
"map": "./url",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
}, {
"map": "For Phone: \n value = phone.number \nFor Email,\n value = organization.email\nFor Website URL: \n value = organization.url\nNote: For phone, HSDS organization linkage is to HSDS phone table using organization.id = phone.organization_id.",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.telecom.value",
"comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.telecom.use",
"requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min": 0,
"definition": "Identifies the purpose for the contact point.",
"isModifier": true,
"short": "home | work | temp | old | mobile - purpose of this contact point",
"mapping": [ {
"map": "XTN.2 - but often indicated by field",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./ContactPointPurpose",
"identity": "servd"
}, {
"map": "Fixed value = 'work' Note: This is a GAP in HSDS but since it is for work related information, it is possible to set this to 'work' drawn from the ContactPointUse value set http://hl7.org/fhir/R4/valueset-contact-point-use.html.",
"identity": "hsds"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointUse"
} ],
"description": "Use of contact point."
},
"max": "1",
"id": "Organization.telecom.use",
"comment": "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.telecom.rank",
"min": 0,
"definition": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.",
"isModifier": false,
"short": "Specify preferred order of use (1 = highest)",
"mapping": [ {
"map": "n/a",
"identity": "v2"
}, {
"map": "n/a",
"identity": "rim"
}, {
"map": "No Source. Note: This a GAP in HSDS. In FHIR, it is used to specify a preferred order in which to use a contact point. The parent Plan-Net profile indicates this is a Must Support element but is optional, So it can be excluded since there is no source.",
"identity": "hsds"
} ],
"type": [ {
"code": "positiveInt"
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.telecom.rank",
"comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.rank"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.telecom.period",
"min": 0,
"definition": "Time period when the contact point was/is in use.",
"isModifier": false,
"short": "Time period when the contact point was/is in use",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, this data element captures the time period when the contact point was/is in use. But it can be excluded since there is no source and it is optional.",
"identity": "hsds"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Organization.telecom.period",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "org-2",
"human": "An address of an organization can never be of use 'home'",
"xpath": "count(f:use[@value='home']) = 0",
"source": "http://hl7.org/fhir/StructureDefinition/Organization",
"severity": "error",
"expression": "where(use = 'home').empty()"
} ],
"path": "Organization.address",
"requirements": "May need to keep track of the organization's addresses for contacting, billing or reporting requirements.",
"min": 1,
"definition": "An address for the organization.",
"isModifier": false,
"short": "An address for the organization",
"mapping": [ {
"map": "ORC-23?",
"identity": "v2"
}, {
"map": ".address",
"identity": "rim"
}, {
"map": "./PrimaryAddress and ./OtherAddresses",
"identity": "servd"
}, {
"map": "n/a",
"identity": "servd"
}, {
"map": "Note: HSDS does not have an address associated with the organization. So the Location table is used to capture address details associated with locations that are part of that organization. Two HSDS tables are used, one for postal_address, the other for physical_address. This linkage is based on organization.id = location.organization_id and location.id = address.location_id. If there are multiple locations and associated addresses, all of those can be included for organization level addresses since there is no indication to identify which location or address is primary to be used as organization address.",
"identity": "hsds"
} ],
"type": [ {
"code": "Address"
} ],
"mustSupport": true,
"max": "*",
"id": "Organization.address",
"condition": [ "org-2" ],
"comment": "Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.",
"base": {
"max": "*",
"min": 0,
"path": "Organization.address"
},
"isSummary": false
}, {
"path": "Organization.address.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "postal_address.id or physical_address_id Note: This data element may be ignored as having the id for the address record isn't essential. If populated, it should be the id from one of the address tables that particular address is referring to.",
"identity": "hsds"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Organization.address.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.address.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Organization.address.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.address.extension",
"min": 0,
"definition": "The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).",
"isModifier": false,
"short": "The absolute geographic location",
"mapping": [ {
"map": "location.latitude Note: There is no location in HSDS at the organization level.",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/geolocation" ]
} ],
"mustSupport": true,
"sliceName": "geolocation",
"max": "1",
"id": "Organization.address.extension:geolocation",
"comment": "The extension can be further extended to include unique geolocation identifiers, confidence, altitude, etc.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.address.use",
"fixedCode": "work",
"requirements": "Allows an appropriate address to be chosen from a list of many.",
"min": 0,
"definition": "The purpose of this address.",
"isModifier": true,
"short": "home | work | temp | old | billing - purpose of this address",
"mapping": [ {
"map": "XAD.7",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./AddressPurpose",
"identity": "servd"
}, {
"map": "Fixed value = 'work' Note: This is a GAP in HSDS but since it is for work related information, it is possible to set this to 'work' drawn from the AddressUse value set http://hl7.org/fhir/R4/valueset-address-use.html.",
"identity": "hsds"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/address-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AddressUse"
} ],
"description": "The use of an address."
},
"max": "1",
"id": "Organization.address.use",
"comment": "Applications can assume that an address is current unless it explicitly says that it is temporary or old.",
"example": [ {
"label": "General",
"valueCode": "home"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.address.type",
"min": 0,
"definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
"isModifier": false,
"short": "postal | physical | both",
"mapping": [ {
"map": "XAD.18",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "address type parameter",
"identity": "vcard"
}, {
"map": "Fixed value = 'postal' or 'physical' Note: This is a GAP in HSDS but it can be inferred by which table is used as a source in the HSDS i.e. postal_address or physical_address respectively.",
"identity": "hsds"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/address-type|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AddressType"
} ],
"description": "The type of an address (physical / postal)."
},
"max": "1",
"id": "Organization.address.type",
"comment": "The definition of Address states that \"address is intended to describe postal addresses, not physical locations\". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](http://hl7.org/fhir/R4/location.html#) resource).",
"example": [ {
"label": "General",
"valueCode": "both"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.address.text",
"requirements": "A renderable, unencoded form.",
"min": 0,
"definition": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.",
"isModifier": false,
"short": "Text representation of the address",
"mapping": [ {
"map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6",
"identity": "v2"
}, {
"map": "./formatted",
"identity": "rim"
}, {
"map": "address label parameter",
"identity": "vcard"
}, {
"map": "Concatenation of address_1, city, state_province, postal_code and country; all separated by comma (,) except dash (-) between state_province and postal_code. Note: The address data elements will be from postal_address or physical_address depending on which address is sourced. In FHIR, this element specifies the entire address as it should be displayed.",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.address.text",
"comment": "Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.",
"example": [ {
"label": "General",
"valueString": "137 Nowhere Street, Erewhon 9132"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.address.line",
"min": 0,
"definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.",
"isModifier": false,
"short": "Street name, number, direction & P.O. Box etc.",
"mapping": [ {
"map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)",
"identity": "v2"
}, {
"map": "AD.part[parttype = AL]",
"identity": "rim"
}, {
"map": "street",
"identity": "vcard"
}, {
"map": "./StreetAddress (newline delimitted)",
"identity": "servd"
}, {
"map": "postal_address.address_1 or \nphysical_address.address_1 Note: address.line in FHIR is an array (list) so address_1 is populated in the first position of the array. If address_2 is available (although deprecated in HSDS), it may be populated in the second position of the array.",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "4",
"id": "Organization.address.line",
"example": [ {
"label": "General",
"valueString": "137 Nowhere Street"
} ],
"orderMeaning": "The order in which lines should appear in an address label",
"base": {
"max": "*",
"min": 0,
"path": "Address.line"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.address.city",
"min": 0,
"definition": "The name of the city, town, suburb, village or other community or delivery center.",
"isModifier": false,
"short": "Name of city, town etc.",
"mapping": [ {
"map": "XAD.3",
"identity": "v2"
}, {
"map": "AD.part[parttype = CTY]",
"identity": "rim"
}, {
"map": "locality",
"identity": "vcard"
}, {
"map": "./Jurisdiction",
"identity": "servd"
}, {
"map": "postal_address.city or physical_address.city",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "Municpality" ],
"max": "1",
"id": "Organization.address.city",
"example": [ {
"label": "General",
"valueString": "Erewhon"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.city"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.address.district",
"min": 0,
"definition": "The name of the administrative area (county).",
"isModifier": false,
"short": "District name (aka county)",
"mapping": [ {
"map": "XAD.9",
"identity": "v2"
}, {
"map": "AD.part[parttype = CNT | CPA]",
"identity": "rim"
}, {
"map": "postal_address.region or physical_address.region",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "County" ],
"max": "1",
"id": "Organization.address.district",
"comment": "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.",
"example": [ {
"label": "General",
"valueString": "Madison"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.district"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.address.state",
"min": 0,
"definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).",
"isModifier": false,
"short": "Sub-unit of country (abbreviations ok)",
"mapping": [ {
"map": "XAD.4",
"identity": "v2"
}, {
"map": "AD.part[parttype = STA]",
"identity": "rim"
}, {
"map": "region",
"identity": "vcard"
}, {
"map": "./Region",
"identity": "servd"
}, {
"map": "./Sites",
"identity": "servd"
}, {
"map": "postal_address.state_province_code or physical_address.state_province_code",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state",
"description": "Two letter USPS alphabetic codes."
},
"alias": [ "Province", "Territory" ],
"max": "1",
"id": "Organization.address.state",
"base": {
"max": "1",
"min": 0,
"path": "Address.state"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.address.postalCode",
"min": 0,
"definition": "A postal code designating a region defined by the postal service.",
"isModifier": false,
"short": "US Zip Codes",
"mapping": [ {
"map": "XAD.5",
"identity": "v2"
}, {
"map": "AD.part[parttype = ZIP]",
"identity": "rim"
}, {
"map": "code",
"identity": "vcard"
}, {
"map": "./PostalIdentificationCode",
"identity": "servd"
}, {
"map": "postal_address.postal_code or physical_address.postal_code",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "Zip" ],
"max": "1",
"id": "Organization.address.postalCode",
"example": [ {
"label": "General",
"valueString": "9132"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.postalCode"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.address.country",
"min": 0,
"definition": "Country - a nation as commonly understood or generally accepted.",
"isModifier": false,
"short": "Country (e.g. can be ISO 3166 2 or 3 letter code)",
"mapping": [ {
"map": "XAD.6",
"identity": "v2"
}, {
"map": "AD.part[parttype = CNT]",
"identity": "rim"
}, {
"map": "country",
"identity": "vcard"
}, {
"map": "./Country",
"identity": "servd"
}, {
"map": "postal_address.country or physical_address.country",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.address.country",
"comment": "ISO 3166 3 letter codes can be used in place of a human readable country name.",
"base": {
"max": "1",
"min": 0,
"path": "Address.country"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.address.period",
"requirements": "Allows addresses to be placed in historical context.",
"min": 0,
"definition": "Time period when address was/is in use.",
"isModifier": false,
"short": "Time period when address was/is in use",
"mapping": [ {
"map": "XAD.12 / XAD.13 + XAD.14",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
}, {
"map": "No Source. May be excluded from the mapping. Note: This a GAP in HSDS. In FHIR, this data element represents the time period when the address was in use for the organization.",
"identity": "hsds"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Organization.address.period",
"example": [ {
"label": "General",
"valuePeriod": {
"end": "2010-07-01",
"start": "2010-03-23"
}
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.partOf",
"requirements": "Need to be able to track the hierarchy of organizations within an organization.",
"min": 0,
"definition": "The organization of which this organization forms a part.",
"isModifier": false,
"short": "The organization of which this organization forms a part",
"mapping": [ {
"map": "No equivalent in HL7 v2",
"identity": "v2"
}, {
"map": ".playedBy[classCode=Part].scoper",
"identity": "rim"
}, {
"map": "n/a",
"identity": "servd"
}, {
"map": "No Source. Note: This a GAP in HSDS. There is no concept of organization hierarchy in HSDS.",
"identity": "hsds"
} ],
"type": [ {
"code": "Reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean": true
} ],
"targetProfile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization" ]
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.partOf",
"base": {
"max": "1",
"min": 0,
"path": "Organization.partOf"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.contact",
"requirements": "Need to keep track of assigned contact points within bigger organization.",
"min": 0,
"definition": "Contact for the organization for a certain purpose.",
"isModifier": false,
"short": "Contact for the organization for a certain purpose",
"mapping": [ {
"map": ".contactParty",
"identity": "rim"
}, {
"map": "Note: contact Table The HSDS contact table contains details of the named contacts associated with the organization. This linkage is based on FHIR organization.id = HSDS contact.organization_id. If there are multiple contacts, all of those can be included for organization level contacts in FHIR since there is no indication to identify which contact is primary.",
"identity": "hsds"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "*",
"id": "Organization.contact",
"comment": "Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.",
"base": {
"max": "*",
"min": 0,
"path": "Organization.contact"
},
"isSummary": false
}, {
"path": "Organization.contact.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "contact.id Note: This data element may be ignored as having the id for the contact record isn't essential.",
"identity": "hsds"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Organization.contact.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.contact.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"mapping": [ {
"map": "contact.department Note: This is a GAP in FHIR. Proposed publishing a new StructureDefinition for this extension, e.g., http://hl7.org/fhir/us/FHIR-IG-Human-Services-Directory/StructureDefinition/contact-department",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Organization.contact.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.contact.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Organization.contact.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.contact.purpose",
"requirements": "Need to distinguish between multiple contact persons.",
"min": 0,
"definition": "Indicates a purpose for which the contact can be reached.",
"isModifier": false,
"short": "The type of contact",
"mapping": [ {
"map": "./type",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP In HSDS. In FHIR, this element is used to indicate the purpose of which the contact can be reached.",
"identity": "hsds"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/contactentity-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPartyType"
} ],
"description": "The purpose for which you would contact a contact party."
},
"max": "1",
"id": "Organization.contact.purpose",
"base": {
"max": "1",
"min": 0,
"path": "Organization.contact.purpose"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.contact.name",
"requirements": "Need to be able to track the person by name.",
"min": 0,
"definition": "A name associated with the contact.",
"isModifier": false,
"short": "A name associated with the contact",
"mapping": [ {
"map": "PID-5, PID-9",
"identity": "v2"
}, {
"map": "./name",
"identity": "rim"
}, {
"map": "contact.name",
"identity": "hsds"
} ],
"type": [ {
"code": "HumanName"
} ],
"max": "1",
"id": "Organization.contact.name",
"base": {
"max": "1",
"min": 0,
"path": "Organization.contact.name"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.contact.telecom",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"definition": "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.",
"isModifier": false,
"short": "Contact details (telephone, email, etc.) for a contact",
"mapping": [ {
"map": "PID-13, PID-14",
"identity": "v2"
}, {
"map": "./telecom",
"identity": "rim"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"mustSupport": true,
"max": "*",
"id": "Organization.contact.telecom",
"base": {
"max": "*",
"min": 0,
"path": "Organization.contact.telecom"
},
"isSummary": false
}, {
"path": "Organization.contact.telecom.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This data element may be ignored as having the id for the telecom record isn't essential and not always available in the HSDS (e.g. phone id is available but there is no separate id for email).",
"identity": "hsds"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Organization.contact.telecom.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.contact.telecom.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Organization.contact.telecom.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.contact.telecom.extension",
"min": 0,
"definition": "An extension representing the days and times a contact point is available",
"isModifier": false,
"short": "Contactpoint Availabletime",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. This FHIR extension is added by Plan-Net profile and represents available hours for the telecom (e.g. customer service phone hours from 8AM-6PM M-F). There is no equivalent mapping to this data element in HSDS since the HSDS schedule table contains details of when a service or location is open, and is not a phone line associated with a contact.",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime" ]
} ],
"sliceName": "contactpoint-availabletime",
"max": "*",
"id": "Organization.contact.telecom.extension:contactpoint-availabletime",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Organization.contact.telecom.extension",
"min": 0,
"definition": "A reference to an alternative point of contact (plannet-PractitionerRole, plannet-Organization, plannet-OrganizationAffiliation, or plannet-Location) for this organization",
"isModifier": false,
"short": "Via Intermediary",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is GAP in HSDS. This FHIR extension added by Plan-Net profile represents a reference to an alternative point of contact. HSDS does not have the source data to represent 'intermediary' as that implies some sort of contact relationship.",
"identity": "hsds"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary" ]
} ],
"sliceName": "via-intermediary",
"max": "*",
"id": "Organization.contact.telecom.extension:via-intermediary",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.contact.telecom.system",
"min": 0,
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"isModifier": false,
"short": "phone | fax | email | pager | url | sms | other",
"mapping": [ {
"map": "XTN.3",
"identity": "v2"
}, {
"map": "./scheme",
"identity": "rim"
}, {
"map": "./ContactPointType",
"identity": "servd"
}, {
"map": "For Phone: \n if phone.type = 'voice' then system = 'phone' \n if phone.type = 'cell' then system = 'phone' \n if phone.type = 'fax' then system = 'fax' \n if phone.type = 'pager' then system = 'pager' \n if phone.type = 'text' then system = 'sms' \n if phone.type = 'textphone' then system = 'sms' \n if phone.type = 'video' then system = 'other' \nFor Email:\n Fixed value = 'email' \nNote: There are multiple sources in HSDS for the telecom in FHIR so the system will be populated based on phone.type mapping or fixed value of 'email' depending on the data populated.",
"identity": "hsds"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointSystem"
} ],
"description": "Telecommunications form for contact point."
},
"max": "1",
"id": "Organization.contact.telecom.system",
"condition": [ "cpt-2" ],
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.contact.telecom.value",
"requirements": "Need to support legacy numbers that are not in a tightly controlled format.",
"min": 0,
"definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"isModifier": false,
"short": "The actual contact point details",
"mapping": [ {
"map": "XTN.1 (or XTN.12)",
"identity": "v2"
}, {
"map": "./url",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
}, {
"map": "For Phone: \n value = phone.number \nFor Email,\n value = conact.email\nNote: For phone, HSDS contact table will be linked to the phone table using contact.id = phone.contact_id.",
"identity": "hsds"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Organization.contact.telecom.value",
"comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.contact.telecom.use",
"requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min": 0,
"definition": "Identifies the purpose for the contact point.",
"isModifier": true,
"short": "home | work | temp | old | mobile - purpose of this contact point",
"mapping": [ {
"map": "XTN.2 - but often indicated by field",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./ContactPointPurpose",
"identity": "servd"
}, {
"map": "Fixed value = 'work' Note: This is a GAP in HSDS but since it is for work-related information, it is possible to set this to 'work' drawn from the ContactPointUse value set http://hl7.org/fhir/R4/valueset-contact-point-use.html",
"identity": "hsds"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointUse"
} ],
"description": "Use of contact point."
},
"max": "1",
"id": "Organization.contact.telecom.use",
"comment": "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.contact.telecom.rank",
"min": 0,
"definition": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.",
"isModifier": false,
"short": "Specify preferred order of use (1 = highest)",
"mapping": [ {
"map": "n/a",
"identity": "v2"
}, {
"map": "n/a",
"identity": "rim"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, it is used to specify a preferred order in which to use a contact point. The parent Plan-Net profile indicates this is a Must Support element but is optional, So it can be excluded since there is no source.",
"identity": "hsds"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "Organization.contact.telecom.rank",
"comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.rank"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.contact.telecom.period",
"min": 0,
"definition": "Time period when the contact point was/is in use.",
"isModifier": false,
"short": "Time period when the contact point was/is in use",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
}, {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, this data element captures the time period when the contact point was/is in use. But it can be excluded since there is no source and it is optional.",
"identity": "hsds"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Organization.contact.telecom.period",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.contact.address",
"requirements": "May need to keep track of a contact party's address for contacting, billing or reporting requirements.",
"min": 0,
"definition": "Visiting or postal addresses for the contact.",
"isModifier": false,
"short": "Visiting or postal addresses for the contact",
"mapping": [ {
"map": "PID-11",
"identity": "v2"
}, {
"map": "./addr",
"identity": "rim"
}, {
"map": "GAP in HSDs. May need to keep track of a contact party's address for contacting, billing or reporting requirements.",
"identity": "hsds"
} ],
"type": [ {
"code": "Address"
} ],
"max": "1",
"id": "Organization.contact.address",
"base": {
"max": "1",
"min": 0,
"path": "Organization.contact.address"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Organization.endpoint",
"requirements": "Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.",
"min": 0,
"definition": "Technical endpoints providing access to services operated for the organization.",
"isModifier": false,
"short": "Technical endpoints providing access to services operated for the organization",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "No Source. Note: This is for the technical implementation of web services for the organization and it is not for source-specific business data. It is marked as Must Support though optional in the Plan-Net profile. At this point, no organizayion specific web services have been identified so it may be ignored.",
"identity": "hsds"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Endpoint" ]
} ],
"mustSupport": true,
"max": "*",
"id": "Organization.endpoint",
"base": {
"max": "*",
"min": 0,
"path": "Organization.endpoint"
},
"isSummary": false
} ]
},
"status": "active",
"id": "c0284bb7-5199-435e-9880-dc9b7ef58f93",
"kind": "resource",
"url": "http://hl7.org/fhir/us/hsds/StructureDefinition/hsds-Organization",
"version": "1.0.0-ballot",
"differential": {
"element": [ {
"id": "Organization",
"path": "Organization"
}, {
"id": "Organization.id",
"path": "Organization.id",
"mapping": [ {
"map": "organization.id Note: Each organization must have a unique system identifier in the source system.",
"identity": "hsds"
} ]
}, {
"id": "Organization.meta",
"path": "Organization.meta",
"mapping": [ {
"map": "Note: The HSDS metadata table contains a record of the changes that have been made to the data in order to maintain provenance information.",
"identity": "hsds"
} ]
}, {
"id": "Organization.meta.id",
"path": "Organization.meta.id",
"mapping": [ {
"map": "metadata.id Note: This data element may be ignored as having the id for the date metadata isn't essential. If populated, it should be id corresponding to the latest action date for given organization as described below.",
"identity": "hsds"
} ]
}, {
"id": "Organization.meta.lastUpdated",
"path": "Organization.meta.lastUpdated",
"mapping": [ {
"map": "metadata.last_action_date Note: The date when data was changed. Since there may be more than one metadata record for each organization, the latest max(last_action_date) needs to be used from metadata where (FHIR) Organization.id = (HSDS) metadata.resource_id.",
"identity": "hsds"
} ]
}, {
"id": "Organization.language",
"path": "Organization.language",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This data element in FHIR is referring to language for the resource context and not the language for the communication for given service or location.",
"identity": "hsds"
} ]
}, {
"id": "Organization.text",
"path": "Organization.text",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This DomainResource.text is meant for textual summary of the resource so organization description is mapped to the org-description extension added by Plan-Net profile.",
"identity": "hsds"
} ]
}, {
"id": "Organization.extension:qualification",
"path": "Organization.extension",
"mapping": [ {
"map": "extension[qualification]:code.url = 'code' extension[qualification]:code.valueCodeableConcept.text = service.accreditations \nNote: This is a GAP in HSDS that can be resolved by having qualifications collected at the organization level. As a workaround, suggested mapping uses the unique set of accreditations from service and concatenated for the organization level as described below.",
"identity": "hsds"
} ],
"sliceName": "qualification"
}, {
"id": "Organization.extension:org-description",
"path": "Organization.extension",
"mapping": [ {
"map": "organization.description Note: This Plan-Net profile added this extension for organization description as opposed to using DomainResource.text data element which is meant for textual summary of the resource.",
"identity": "hsds"
} ],
"sliceName": "org-description"
}, {
"id": "Organization.identifier",
"path": "Organization.identifier"
}, {
"id": "Organization.identifier.id",
"path": "Organization.identifier.id",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This data element may be ignored as having the id for the identifier record isn't essential and is not available in HSDS since the tax ID is directly on the organization table.",
"identity": "hsds"
} ]
}, {
"id": "Organization.identifier.use",
"path": "Organization.identifier.use",
"mapping": [ {
"map": "Fixed value = 'official' Note: Since the organization business identifier in HSDS is organization.tax id which is used for official purpose, this element is to be set with a fixed value 'official' drawn from the code system IdentifierUse http://hl7.org/fhir/identifier-use.",
"identity": "hsds"
} ]
}, {
"id": "Organization.identifier.type",
"path": "Organization.identifier.type",
"mapping": [ {
"map": "Fixed value = 'TAX' Note: Since the organization business identifier in HSDS is organization.tax id which is used for the tax, this element is to be set with a fixed value 'TAX' drawn from the IdentifierType code system – http://terminology.hl7.org/CodeSystem/v2-0203 [an HL7-defined code system of concepts specifying type of identifier].",
"identity": "hsds"
} ]
}, {
"id": "Organization.identifier.system",
"path": "Organization.identifier.system",
"mapping": [ {
"map": "Fixed value = 'urn:us:gov:irs' Note: Since the organization business identifier in HSDS is organization.tax id which is issued by IRS, this element is to be set with a fixed value with IRS URN.",
"identity": "hsds"
} ]
}, {
"id": "Organization.identifier.value",
"path": "Organization.identifier.value",
"mapping": [ {
"map": "organization.tax_id Note: This is the only business identifier in HSDS at this time.",
"identity": "hsds"
} ]
}, {
"id": "Organization.identifier.period",
"path": "Organization.identifier.period",
"mapping": [ {
"map": "organization.year_incorporated Note: HSDS organization.year_incorporated may not always be the same as when the TAX ID was issued (especially if a company merged or split). Technically year_incorporated is a GAP in FHIR and should be added as an extension. Also the effective date of the identifier (mapped to period here) is GAP in HSDS. But until both of those GAPs are addressed, the above mapping is proposed as a work around.",
"identity": "hsds"
} ]
}, {
"id": "Organization.identifier.assigner",
"path": "Organization.identifier.assigner",
"mapping": [ {
"map": "Fixed value = 'www.irs.gov' Note: This is GAP in HSDS but it can be implicitly inferred. Since the organization business identifier in HSDS is organization.tax id which is issued by IRS, this element is to be set with a fixed value with IRS website link as a reference.",
"identity": "hsds"
} ]
}, {
"id": "Organization.active",
"path": "Organization.active",
"mapping": [ {
"map": "Fixed value = 'true' Note: HSDS organization does not have a status but this is required in FHIR so fixed value is proposed to indicate that organization is active.",
"identity": "hsds"
} ]
}, {
"id": "Organization.type",
"path": "Organization.type",
"mapping": [ {
"map": "Fixed values: type.code = 'atyprv' and type.system = 'http://hl7.org/fhir/us/DaVinci-pdex-plan-net/ValueSet/OrgTypeVS' Note: This is a GAP in HSDS but required per Plan-Net profile. Among the allowable codes, 'atyprv' is proposed to represent 'Providers that do not provide healthcare' as the most appropriate for the human services providers.",
"identity": "hsds"
} ],
"patternCodeableConcept": {
"coding": [ {
"code": "atyprv",
"system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/OrgTypeCS"
} ]
}
}, {
"id": "Organization.name",
"path": "Organization.name",
"mapping": [ {
"map": "organization.name",
"identity": "hsds"
} ]
}, {
"id": "Organization.alias",
"path": "Organization.alias",
"mapping": [ {
"map": "organization.alternate_name Note: Since there is only one alternate name in HSDS but the alias is an array (list) in FHIR, this will map to the first occurrence of the array.",
"identity": "hsds"
} ]
}, {
"id": "Organization.telecom",
"path": "Organization.telecom",
"mapping": [ {
"map": "Note: This FHIR structure contains contact details of the organization using the ContactPoint datatype (Details for all kinds of technology-mediated contact points for a person or organization, including telephone, email, etc.).",
"identity": "hsds"
} ]
}, {
"id": "Organization.telecom.id",
"path": "Organization.telecom.id",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This data element may be ignored as having the id for the telecom record isn't essential and not always available in the HSDS (e.g. phone id is available but there is no separate id for email or website URL).",
"identity": "hsds"
} ]
}, {
"id": "Organization.telecom.extension:contactpoint-availabletime",
"path": "Organization.telecom.extension",
"mapping": [ {
"map": "No Source. Note: This is a GAP in HSDS. This FHIR extension is added by Plan-Net profile and represents available hours for the telecom (e.g. customer service phone hours from 8AM-6PM M-F). There is no equivalent mapping to this data element in HSDS since the HSDS schedule table contains details of when a service or location is open, and is not a phone line associated with an organization.",
"identity": "hsds"
} ],
"sliceName": "contactpoint-availabletime"
}, {
"id": "Organization.telecom.extension:via-intermediary",
"path": "Organization.telecom.extension",
"mapping": [ {
"map": "No Source. Note: This is GAP in HSDS. This FHIR extension added by Plan-Net profile represents a reference to an alternative point of contact. HSDS does not have the source data to represent 'intermediary' as that implies some sort of organizational relationship.",
"identity": "hsds"
} ],
"sliceName": "via-intermediary"
}, {
"id": "Organization.telecom.system",
"path": "Organization.telecom.system",
"mapping": [ {
"map": "For Phone: \n if phone.type = 'voice' then system = 'phone' \n if phone.type = 'cell' then system = 'phone' \n if phone.type = 'fax' then system = 'fax' \n if phone.type = 'pager' then system = 'pager' \n if phone.type = 'text' then system = 'sms' \n if phone.type = 'textphone' then system = 'sms' \n if phone.type = 'video' then system = 'other' \nFor Email:\n Fixed value = 'email' \nFor Website URL:\n Fixed value = 'url' \nNote: There are multiple sources in HSDS for the telecom in FHIR so the system will be populated based on phone.type mapping or fixed value of 'email' or 'url' depending on the data populated. Drawn from the ContactPointSystem value set [http://hl7.org/fhir/ValueSet/contact-point-system]",
"identity": "hsds"
} ]
}, {
"id": "Organization.telecom.value",
"path": "Organization.telecom.value",
"mapping": [ {
"map": "For Phone: \n value = phone.number \nFor Email,\n value = organization.email\nFor Website URL: \n value = organization.url\nNote: For phone, HSDS organization linkage is to HSDS phone table using organization.id = phone.organization_id.",
"identity": "hsds"
} ]
}, {
"id": "Organization.telecom.use",
"path": "Organization.telecom.use",
"mapping": [ {
"map": "Fixed value = 'work' Note: This is a GAP in HSDS but since it is for work related information, it is possible to set this to 'work' drawn from the ContactPointUse value set http://hl7.org/fhir/R4/valueset-contact-point-use.html.",
"identity": "hsds"
} ]
}, {
"id": "Organization.telecom.rank",
"path": "Organization.telecom.rank",
"mapping": [ {
"map": "No Source. Note: This a GAP in HSDS. In FHIR, it is used to specify a preferred order in which to use a contact point. The parent Plan-Net profile indicates this is a Must Support element but is optional, So it can be excluded since there is no source.",
"identity": "hsds"
} ]
}, {
"id": "Organization.telecom.period",
"path": "Organization.telecom.period",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, this data element captures the time period when the contact point was/is in use. But it can be excluded since there is no source and it is optional.",
"identity": "hsds"
} ]
}, {
"id": "Organization.address",
"path": "Organization.address",
"mapping": [ {
"map": "Note: HSDS does not have an address associated with the organization. So the Location table is used to capture address details associated with locations that are part of that organization. Two HSDS tables are used, one for postal_address, the other for physical_address. This linkage is based on organization.id = location.organization_id and location.id = address.location_id. If there are multiple locations and associated addresses, all of those can be included for organization level addresses since there is no indication to identify which location or address is primary to be used as organization address.",
"identity": "hsds"
} ]
}, {
"id": "Organization.address.id",
"path": "Organization.address.id",
"mapping": [ {
"map": "postal_address.id or physical_address_id Note: This data element may be ignored as having the id for the address record isn't essential. If populated, it should be the id from one of the address tables that particular address is referring to.",
"identity": "hsds"
} ]
}, {
"id": "Organization.address.extension:geolocation",
"path": "Organization.address.extension",
"mapping": [ {
"map": "location.latitude Note: There is no location in HSDS at the organization level.",
"identity": "hsds"
} ],
"sliceName": "geolocation"
}, {
"id": "Organization.address.use",
"path": "Organization.address.use",
"mapping": [ {
"map": "Fixed value = 'work' Note: This is a GAP in HSDS but since it is for work related information, it is possible to set this to 'work' drawn from the AddressUse value set http://hl7.org/fhir/R4/valueset-address-use.html.",
"identity": "hsds"
} ],
"fixedCode": "work"
}, {
"id": "Organization.address.type",
"path": "Organization.address.type",
"mapping": [ {
"map": "Fixed value = 'postal' or 'physical' Note: This is a GAP in HSDS but it can be inferred by which table is used as a source in the HSDS i.e. postal_address or physical_address respectively.",
"identity": "hsds"
} ]
}, {
"id": "Organization.address.text",
"path": "Organization.address.text",
"mapping": [ {
"map": "Concatenation of address_1, city, state_province, postal_code and country; all separated by comma (,) except dash (-) between state_province and postal_code. Note: The address data elements will be from postal_address or physical_address depending on which address is sourced. In FHIR, this element specifies the entire address as it should be displayed.",
"identity": "hsds"
} ]
}, {
"id": "Organization.address.line",
"path": "Organization.address.line",
"mapping": [ {
"map": "postal_address.address_1 or \nphysical_address.address_1 Note: address.line in FHIR is an array (list) so address_1 is populated in the first position of the array. If address_2 is available (although deprecated in HSDS), it may be populated in the second position of the array.",
"identity": "hsds"
} ]
}, {
"id": "Organization.address.city",
"path": "Organization.address.city",
"mapping": [ {
"map": "postal_address.city or physical_address.city",
"identity": "hsds"
} ]
}, {
"id": "Organization.address.district",
"path": "Organization.address.district",
"mapping": [ {
"map": "postal_address.region or physical_address.region",
"identity": "hsds"
} ]
}, {
"id": "Organization.address.state",
"path": "Organization.address.state",
"mapping": [ {
"map": "postal_address.state_province_code or physical_address.state_province_code",
"identity": "hsds"
} ]
}, {
"id": "Organization.address.postalCode",
"path": "Organization.address.postalCode",
"mapping": [ {
"map": "postal_address.postal_code or physical_address.postal_code",
"identity": "hsds"
} ]
}, {
"id": "Organization.address.country",
"path": "Organization.address.country",
"mapping": [ {
"map": "postal_address.country or physical_address.country",
"identity": "hsds"
} ]
}, {
"id": "Organization.address.period",
"path": "Organization.address.period",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This a GAP in HSDS. In FHIR, this data element represents the time period when the address was in use for the organization.",
"identity": "hsds"
} ]
}, {
"id": "Organization.partOf",
"path": "Organization.partOf",
"mapping": [ {
"map": "No Source. Note: This a GAP in HSDS. There is no concept of organization hierarchy in HSDS.",
"identity": "hsds"
} ]
}, {
"id": "Organization.contact",
"path": "Organization.contact",
"mapping": [ {
"map": "Note: contact Table The HSDS contact table contains details of the named contacts associated with the organization. This linkage is based on FHIR organization.id = HSDS contact.organization_id. If there are multiple contacts, all of those can be included for organization level contacts in FHIR since there is no indication to identify which contact is primary.",
"identity": "hsds"
} ]
}, {
"id": "Organization.contact.id",
"path": "Organization.contact.id",
"mapping": [ {
"map": "contact.id Note: This data element may be ignored as having the id for the contact record isn't essential.",
"identity": "hsds"
} ]
}, {
"id": "Organization.contact.extension",
"path": "Organization.contact.extension",
"mapping": [ {
"map": "contact.department Note: This is a GAP in FHIR. Proposed publishing a new StructureDefinition for this extension, e.g., http://hl7.org/fhir/us/FHIR-IG-Human-Services-Directory/StructureDefinition/contact-department",
"identity": "hsds"
} ]
}, {
"id": "Organization.contact.purpose",
"path": "Organization.contact.purpose",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP In HSDS. In FHIR, this element is used to indicate the purpose of which the contact can be reached.",
"identity": "hsds"
} ]
}, {
"id": "Organization.contact.name",
"path": "Organization.contact.name",
"mapping": [ {
"map": "contact.name",
"identity": "hsds"
} ]
}, {
"id": "Organization.contact.telecom.id",
"path": "Organization.contact.telecom.id",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This data element may be ignored as having the id for the telecom record isn't essential and not always available in the HSDS (e.g. phone id is available but there is no separate id for email).",
"identity": "hsds"
} ]
}, {
"id": "Organization.contact.telecom.extension:contactpoint-availabletime",
"path": "Organization.contact.telecom.extension",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. This FHIR extension is added by Plan-Net profile and represents available hours for the telecom (e.g. customer service phone hours from 8AM-6PM M-F). There is no equivalent mapping to this data element in HSDS since the HSDS schedule table contains details of when a service or location is open, and is not a phone line associated with a contact.",
"identity": "hsds"
} ],
"sliceName": "contactpoint-availabletime"
}, {
"id": "Organization.contact.telecom.extension:via-intermediary",
"path": "Organization.contact.telecom.extension",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is GAP in HSDS. This FHIR extension added by Plan-Net profile represents a reference to an alternative point of contact. HSDS does not have the source data to represent 'intermediary' as that implies some sort of contact relationship.",
"identity": "hsds"
} ],
"sliceName": "via-intermediary"
}, {
"id": "Organization.contact.telecom.system",
"path": "Organization.contact.telecom.system",
"mapping": [ {
"map": "For Phone: \n if phone.type = 'voice' then system = 'phone' \n if phone.type = 'cell' then system = 'phone' \n if phone.type = 'fax' then system = 'fax' \n if phone.type = 'pager' then system = 'pager' \n if phone.type = 'text' then system = 'sms' \n if phone.type = 'textphone' then system = 'sms' \n if phone.type = 'video' then system = 'other' \nFor Email:\n Fixed value = 'email' \nNote: There are multiple sources in HSDS for the telecom in FHIR so the system will be populated based on phone.type mapping or fixed value of 'email' depending on the data populated.",
"identity": "hsds"
} ]
}, {
"id": "Organization.contact.telecom.value",
"path": "Organization.contact.telecom.value",
"mapping": [ {
"map": "For Phone: \n value = phone.number \nFor Email,\n value = conact.email\nNote: For phone, HSDS contact table will be linked to the phone table using contact.id = phone.contact_id.",
"identity": "hsds"
} ]
}, {
"id": "Organization.contact.telecom.use",
"path": "Organization.contact.telecom.use",
"mapping": [ {
"map": "Fixed value = 'work' Note: This is a GAP in HSDS but since it is for work-related information, it is possible to set this to 'work' drawn from the ContactPointUse value set http://hl7.org/fhir/R4/valueset-contact-point-use.html",
"identity": "hsds"
} ]
}, {
"id": "Organization.contact.telecom.rank",
"path": "Organization.contact.telecom.rank",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, it is used to specify a preferred order in which to use a contact point. The parent Plan-Net profile indicates this is a Must Support element but is optional, So it can be excluded since there is no source.",
"identity": "hsds"
} ]
}, {
"id": "Organization.contact.telecom.period",
"path": "Organization.contact.telecom.period",
"mapping": [ {
"map": "No Source. May be excluded from the mapping. Note: This is a GAP in HSDS. In FHIR, this data element captures the time period when the contact point was/is in use. But it can be excluded since there is no source and it is optional.",
"identity": "hsds"
} ]
}, {
"id": "Organization.contact.address",
"path": "Organization.contact.address",
"mapping": [ {
"map": "GAP in HSDs. May need to keep track of a contact party's address for contacting, billing or reporting requirements.",
"identity": "hsds"
} ]
}, {
"id": "Organization.endpoint",
"path": "Organization.endpoint",
"mapping": [ {
"map": "No Source. Note: This is for the technical implementation of web services for the organization and it is not for source-specific business data. It is marked as Must Support though optional in the Plan-Net profile. At this point, no organizayion specific web services have been identified so it may be ignored.",
"identity": "hsds"
} ]
} ]
},
"contact": [ {
"name": "HL7 Human and Social Services Work Group",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/hsswg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization"
}