HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)

This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions

OrganizationProfile

 

The official URL for this profile is: 

http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Organization

A social or legal structure formed by human beings.

This profile builds on US Core Organization Profile.

This profile was published on Fri Aug 17 00:00:00 AEST 2018 as a draft by The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC).

View the corresponding OrganizationModel logical model.

Summary

Mandatory: 0 element (2 nested mandatory elements)

Structures

This structure refers to these other structures:

BC Mapping Source

This structure represents the following BC mapping definition:

cimi.entity.Organization maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization:
  OrganizationName maps to name
  OrganizationAlias maps to alias  // I wish FHIR allowed multiple names, but it doesn't
  Type maps to type
  OrganizationIdentifier maps to identifier
  Address maps to address
  ContactPoint maps to contact
  ActiveFlag maps to active
  PartOf maps to partOf
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*BC Organization Profile
... 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 SΣI1..*OrganizationIdentifierProfileIdentifies this organization across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ1..1uriThe namespace for the identifier value
.... value Σ0..1stringThe value that is unique
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type Σ1..1CodeableConceptKind of organization
Binding: OrganizationType (required)
... name SΣI1..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
... address SI1..*AddressAn address for the organization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
.... text Σ0..1stringText representation of the address
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city SΣ0..1stringName of city, town etc.
.... district Σ0..1stringDistrict name (aka county)
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
.... postalCode SΣ0..1stringUS Zip Codes
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
... partOf Σ0..1Reference(BC Organization Profile)The organization of which this organization forms a part
... contact I1..*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)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Summary

Mandatory: 0 element (2 nested mandatory elements)

Structures

This structure refers to these other structures:

BC Mapping Source

This structure represents the following BC mapping definition:

cimi.entity.Organization maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization:
  OrganizationName maps to name
  OrganizationAlias maps to alias  // I wish FHIR allowed multiple names, but it doesn't
  Type maps to type
  OrganizationIdentifier maps to identifier
  Address maps to address
  ContactPoint maps to contact
  ActiveFlag maps to active
  PartOf maps to partOf

Differential View

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*BC Organization Profile
... 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 SΣI1..*OrganizationIdentifierProfileIdentifies this organization across multiple systems
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ1..1uriThe namespace for the identifier value
.... value Σ0..1stringThe value that is unique
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type Σ1..1CodeableConceptKind of organization
Binding: OrganizationType (required)
... name SΣI1..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
... address SI1..*AddressAn address for the organization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
.... text Σ0..1stringText representation of the address
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
.... city SΣ0..1stringName of city, town etc.
.... district Σ0..1stringDistrict name (aka county)
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
.... postalCode SΣ0..1stringUS Zip Codes
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
... partOf Σ0..1Reference(BC Organization Profile)The organization of which this organization forms a part
... contact I1..*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)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

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

 

Terminology Bindings

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

 

Constraints

IdPathDetailsRequirements
dom-2OrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1OrganizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4OrganizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3OrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
org-1OrganizationThe organization SHALL at least have a name or an id, and possibly more than one
: (identifier.count() + name.count()) > 0
org-3Organization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
org-2Organization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
ele-1Organization.contactAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())