STU 2 Ballot

This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) v1.6.0. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: DAF-core-organization

This profile sets minimum expectations for the Organization resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the DAF-Organization profile:

  • Query for an address or telephone number by organization name
  • Query for an organization by name or address
Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and an example are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Organization must have:

  1. A name
  2. An identifier
  3. A status of the organization
  4. A list of contact information
  5. Endpoint information

Profile specific implementation guidance:

  • none

Note to Balloters: the following elements are being considered for inclusion into this profile:

  1. An Organization type
Example: Organization Example: example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-organization

This profile was published on Mon Aug 01 00:00:00 AEST 2016 as a draft by Health Level Seven International (FHIR-Infrastructure).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Organization

Complete Summary of the Mandatory Requirements

  1. At least one identifier in Organization.identifier
    • NPI preferred
    • Tax id is allowed
    • Local id is allowed in addition to ‘authoritative’ identifier
  2. One status in Organization.active
  3. At least one name in Organization.name
  4. At least one contact in Organization.telecom
  5. At least one address in Organization.address
  6. At least one endpoint in Organization.endpoint

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A grouping of people or organizations with a common purpose
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
org-1: The organization SHALL at least have a name or an id, and possibly more than one
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SI1..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!∑0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S1..1uriThe namespace for the identifier
Example: NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier
.... value ∑0..1stringThe value that is unique
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!S1..1booleanWhether the organization's record is still in active use
... type ∑0..1CodeableConceptKind of organization
Binding: OrganizationType (example)
... name SI1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI1..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address SI1..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city S0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state S0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
.... postalCode S0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... partOf ∑0..1Reference(Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint S0..*Reference(Endpoint)The technical details of an endpoint that can be used for electronic services

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

This structure is derived from Organization

Summary

Mandatory: 6 elements
Must-Support: 11 elements

Differential View

This structure is derived from Organization

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A grouping of people or organizations with a common purpose
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
org-1: The organization SHALL at least have a name or an id, and possibly more than one
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SI1..*IdentifierIdentifies this organization across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!∑0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S1..1uriThe namespace for the identifier
Example: NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier
.... value ∑0..1stringThe value that is unique
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!S1..1booleanWhether the organization's record is still in active use
... type ∑0..1CodeableConceptKind of organization
Binding: OrganizationType (example)
... name SI1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI1..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address SI1..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city S0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state S0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
.... postalCode S0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... partOf ∑0..1Reference(Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint S0..*Reference(Endpoint)The technical details of an endpoint that can be used for electronic services

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Organization.languageCommon LanguagesextensibleCommon Languages
Organization.identifier.useIdentifierUserequiredIdentifierUse
Organization.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Organization.typeOrganizationTypeexampleOrganizationType
Organization.address.useAddressUserequiredAddressUse
Organization.address.typeAddressTyperequiredAddressType
Organization.address.stateUSPS Two Letter Alphabetic CodesrequiredUSPS Two Letter Alphabetic Codes
Organization.contact.purposeContactEntityTypeextensibleContactEntityType

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2OrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1OrganizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4OrganizationIf 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))
dom-3OrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
org-1OrganizationThe organization SHALL at least have a name or an id, and possibly more than one
XPath: count(f:identifier | f:name) > 0
org-3Organization.telecomThe telecom of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
org-2Organization.addressAn address of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
.