Guia de Implementação da OMNISAUDE - CORE
0.0.1 - draft Brazil flag

Guia de Implementação da OMNISAUDE - CORE - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Organization (OMNI)

Official URL: https://fhir.omnisaude.co/r4/core/StructureDefinition/organizacao Version: 0.0.1
Draft as of 2025-04-10 Computable Name: Organizacao

Organization Profile da Omnisaude baseado no IPS.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* OrganizationUvIps 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-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... periodo 0..1 Period Extension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... active ?!Σ 1..1 boolean Whether the organization's record is still in active use
ele-1: All FHIR elements must have a @value or children
... name SΣC 1..1 string Name used for the organization
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: 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()
dom-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0

This structure is derived from OrganizationUvIps

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization OrganizationUvIps
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... periodo 0..1 Period Extension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... identifier 1..* Identifier Identifies this organization across multiple systems
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... active 1..1 boolean Whether the organization's record is still in active use
.... system 1..1 code phone | fax | email | pager | url | sms | other
.... value 1..1 string The actual contact point details
... address
.... Slices for line 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
..... line:bairro 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
..... line:logradouro 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
..... line:tipoLogradouro 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
..... line:numero 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
..... line:complemento 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
.... city 0..1 string Name of city, town etc.
Binding: Município (extensible)
.... state 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Organization.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Organization.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Organization.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* OrganizationUvIps A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... periodo 0..1 Period Extension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier ΣC 1..* Identifier Identifies this organization across multiple systems
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 1..1 boolean Whether the organization's record is still in active use
... type Σ 0..* CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣC 1..1 string Name used for the organization
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom C 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address C 0..* Address An address for the organization
org-2: An address of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... Slices for line Σ 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:bairro Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:logradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:tipoLogradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:numero Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:complemento Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
.... city Σ 0..1 string Name of city, town etc.
Binding: Município (extensible)
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact 0..* BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1 HumanName A name associated with the contact
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address 0..1 Address Visiting or postal addresses for the contact
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Organization.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Organization.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Organization.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: 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()
dom-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from OrganizationUvIps

Summary

Mandatory: 4 elements(2 nested mandatory elements)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Organization.address.line

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* OrganizationUvIps 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-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... periodo 0..1 Period Extension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... active ?!Σ 1..1 boolean Whether the organization's record is still in active use
ele-1: All FHIR elements must have a @value or children
... name SΣC 1..1 string Name used for the organization
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: 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()
dom-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0

Differential View

This structure is derived from OrganizationUvIps

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization OrganizationUvIps
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... periodo 0..1 Period Extension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... identifier 1..* Identifier Identifies this organization across multiple systems
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... active 1..1 boolean Whether the organization's record is still in active use
.... system 1..1 code phone | fax | email | pager | url | sms | other
.... value 1..1 string The actual contact point details
... address
.... Slices for line 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
..... line:bairro 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
..... line:logradouro 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
..... line:tipoLogradouro 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
..... line:numero 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
..... line:complemento 0..1 string Street name, number, direction & P.O. Box etc.
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
.... city 0..1 string Name of city, town etc.
Binding: Município (extensible)
.... state 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Organization.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Organization.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Organization.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* OrganizationUvIps A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... periodo 0..1 Period Extension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier ΣC 1..* Identifier Identifies this organization across multiple systems
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 1..1 boolean Whether the organization's record is still in active use
... type Σ 0..* CodeableConcept Kind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣC 1..1 string Name used for the organization
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom C 0..* ContactPoint A contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address C 0..* Address An address for the organization
org-2: An address of an organization can never be of use 'home'
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... Slices for line Σ 0..* string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:$this.id
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:bairro Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: bairro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:logradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: logradouro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:tipoLogradouro Σ 0..1 string Street name, number, direction & P.O. Box etc.
Binding: Tipo de Logradouro (extensible)
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: tipoLogradouro
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:numero Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: numero
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
..... line:complemento Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
...... id 0..1 string xml:id (or equivalent in JSON)
Required Pattern: complemento
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 string Primitive value for string
Max Length:1048576
.... city Σ 0..1 string Name of city, town etc.
Binding: Município (extensible)
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Unidade Federativa (extensible)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Iso3166-1-3 (required)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
... contact 0..* BackboneElement Contact for the organization for a certain purpose
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1 HumanName A name associated with the contact
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address 0..1 Address Visiting or postal addresses for the contact
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Organization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Organization.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Organization.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Organization.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Organization.address.line:tipoLogradouroextensibleTipoLogradouro (a valid code from Tipo de Logradouro)
https://fhir.omnisaude.co/r4/core/ValueSet/tipo-logradouro
from this IG
Organization.address.cityextensibleMunicípio
http://www.saude.gov.br/fhir/r4/ValueSet/BRMunicipio-1.0
Organization.address.stateextensibleUnidade Federativa
http://www.saude.gov.br/fhir/r4/ValueSet/BRUnidadeFederativa-1.0
Organization.address.countryrequiredIso3166-1-3
http://hl7.org/fhir/ValueSet/iso3166-1-3
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: 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()
dom-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

This structure is derived from OrganizationUvIps

Summary

Mandatory: 4 elements(2 nested mandatory elements)

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Organization.address.line

 

Other representations of profile: CSV, Excel, Schematron