BBMRI.de/GBA Implementation Guide
1.2.0 - CI Build

BBMRI.de/GBA Implementation Guide - Local Development build (v1.2.0). See the Directory of published versions

Resource Profile: Biobank

Official URL: https://fhir.bbmri.de/StructureDefinition/Biobank Version: 1.2.0
Active as of 2023-09-01 Computable Name: Biobank

Usage:

Formal Views of Profile Content

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

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*OrganizationA grouping of people or organizations with a common purpose
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... description S1..1stringExtension
URL: https://fhir.bbmri.de/StructureDefinition/OrganizationDescription
... bioresourceReference 0..1stringBioresource reference
URL: https://fhir.bbmri.de/StructureDefinition/BioresourceReference
... itSupport 0..1(Complex)IT Support
URL: https://fhir.bbmri.de/StructureDefinition/ITSupport
... partnerCharterSigned 0..1booleanPartner charter signed
URL: https://fhir.bbmri.de/StructureDefinition/PartnerCharterSigned
... collaboration 0..1(Complex)Collaboration
URL: https://fhir.bbmri.de/StructureDefinition/Collaboration
... capabilities 0..*CodeableConceptExtension
URL: https://fhir.bbmri.de/StructureDefinition/Capabilities
Binding: Biobank Capabilities (required)
... qualityStandard S0..*CodeableConceptExtension
URL: https://fhir.bbmri.de/StructureDefinition/QualityStandard
Binding: Quality Standard (required)
... Slices for identifier 1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:Bbmri-EricId S1..1IdentifierIdentifies this organization across multiple systems
..... system S0..1uriThe namespace for the identifier value
Fixed Value: http://www.bbmri-eric.eu/
..... value SC0..1stringThe value that is unique
bbmri-id-1: bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present).
... name S1..1stringName used for the organization
... alias S0..1stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom 0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:url S0..*ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: url
..... value 1..1stringThe actual contact point details
... address 1..*AddressAn address for the organization
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation 0..*(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... country S1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... Slices for contact 2..*BackboneElementContact for the organization for a certain purpose
Slice: Unordered, Open by value:purpose.coding.code
.... contact:head S1..1BackboneElementContact for the organization for a certain purpose
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... headRole 0..1stringHead role
URL: https://fhir.bbmri.de/StructureDefinition/ContactRole
..... purpose S1..1CodeableConceptThe type of contact
...... coding
....... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/contactentity-type
....... code 0..1codeSymbol in syntax defined by the system
Fixed Value: ADMIN
..... name 1..1HumanNameA name associated with the contact
...... family S1..1stringFamily name (often called 'Surname')
...... given S1..*stringGiven names (not always 'first'). Includes middle names
...... prefix S0..*stringParts that come before the name
...... suffix S0..*stringParts that come after the name
.... contact:contact 1..1BackboneElementContact for the organization for a certain purpose
..... purpose S1..1CodeableConceptThe type of contact
...... coding 0..*CodingCode defined by a terminology system
....... system 0..1uriIdentity of the terminology system
Fixed Value: https://fhir.bbmri.de/CodeSystem/ContactType
....... code 0..1codeSymbol in syntax defined by the system
Fixed Value: RESEARCH
..... name
...... family S0..1stringFamily name (often called 'Surname')
...... given S0..*stringGiven names (not always 'first'). Includes middle names
...... prefix S0..*stringParts that come before the name
...... suffix S0..*stringParts that come after the name
..... Slices for telecom 1..*ContactPointContact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
...... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
....... system S0..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
....... value S0..1stringThe actual contact point details
...... telecom:email 1..1ContactPointContact details (telephone, email, etc.) for a contact
....... system S0..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
....... value S1..1stringThe actual contact point details
..... address 1..1AddressVisiting or postal addresses for the contact
...... line S0..*stringStreet name, number, direction & P.O. Box etc.
...... city S0..1stringName of city, town etc.
...... postalCode S0..1stringPostal code for area
...... country S1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
bbmri-id-1warningOrganization.identifier:Bbmri-EricId.valuebbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present).
: matches('^bbmri-eric:ID:([A-Z]){2}_([a-zA-Z0-9])+$')
Make sure valid BBMRI IDs are provided
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*OrganizationA grouping of people or organizations with a common purpose
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... description S1..1stringExtension
URL: https://fhir.bbmri.de/StructureDefinition/OrganizationDescription
... juridicalPerson S1..1stringExtension
URL: https://fhir.bbmri.de/StructureDefinition/JuridicalPerson
... itSupport 0..1(Complex)IT Support
URL: https://fhir.bbmri.de/StructureDefinition/ITSupport
... partnerCharterSigned 0..1booleanPartner charter signed
URL: https://fhir.bbmri.de/StructureDefinition/PartnerCharterSigned
... collaboration 0..1(Complex)Collaboration
URL: https://fhir.bbmri.de/StructureDefinition/Collaboration
... capabilities 0..*CodeableConceptExtension
URL: https://fhir.bbmri.de/StructureDefinition/Capabilities
Binding: Biobank Capabilities (required)
... qualityStandard S0..*CodeableConceptExtension
URL: https://fhir.bbmri.de/StructureDefinition/QualityStandard
Binding: Quality Standard (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier ΣC1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:Bbmri-EricId SΣC1..1IdentifierIdentifies this organization across multiple systems
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ0..1uriThe namespace for the identifier value
Fixed Value: http://www.bbmri-eric.eu/
..... value SΣC0..1stringThe value that is unique
bbmri-id-1: bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present).
Example General: 123456
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... name SΣC1..1stringName used for the organization
... alias S0..1stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom C0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:url SC0..*ContactPointA contact detail for the organization
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: url
..... value Σ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... address C1..*AddressAn address for the organization
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation 0..*(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... country SΣ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... Slices for contact 2..*BackboneElementContact for the organization for a certain purpose
Slice: Unordered, Open by value:purpose.coding.code
.... contact:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... contact:head S1..1BackboneElementContact for the organization for a certain purpose
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... headRole 0..1stringHead role
URL: https://fhir.bbmri.de/StructureDefinition/ContactRole
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose S1..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

..... name 1..1HumanNameA name associated with the contact
...... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

...... family SΣ1..1stringFamily name (often called 'Surname')
...... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... contact:contact 1..1BackboneElementContact for the organization for a certain purpose
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose S1..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

...... coding Σ0..*CodingCode defined by a terminology system
....... system Σ0..1uriIdentity of the terminology system
Fixed Value: https://fhir.bbmri.de/CodeSystem/ContactType
....... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: RESEARCH
..... name 0..1HumanNameA name associated with the contact
...... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

...... family SΣ0..1stringFamily name (often called 'Surname')
...... given SΣ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... Slices for telecom 1..*ContactPointContact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
...... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
....... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
....... value SΣ0..1stringThe actual contact point details
....... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... telecom:email 1..1ContactPointContact details (telephone, email, etc.) for a contact
....... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
....... value SΣ1..1stringThe actual contact point details
....... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... address 1..1AddressVisiting or postal addresses for the contact
...... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
...... 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
Example General: 137 Nowhere Street
...... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
...... postalCode SΣ0..1stringPostal code for area
Example General: 9132
...... country SΣ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.identifier:Bbmri-EricId.userequiredIdentifierUse
Organization.telecom:url.systemrequiredFixed Value: url
Organization.telecom:url.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.contact:head.purposeextensibleContactEntityType
Organization.contact:head.name.userequiredNameUse
Organization.contact:contact.purposeextensibleContactEntityType
Organization.contact:contact.name.userequiredNameUse
Organization.contact:contact.telecom:phone.systemrequiredFixed Value: phone
Organization.contact:contact.telecom:phone.userequiredContactPointUse
Organization.contact:contact.telecom:email.systemrequiredFixed Value: email
Organization.contact:contact.telecom:email.userequiredContactPointUse
Organization.contact:contact.address.userequiredAddressUse

Constraints

IdGradePath(s)DetailsRequirements
bbmri-id-1warningOrganization.identifier:Bbmri-EricId.valuebbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present).
: matches('^bbmri-eric:ID:([A-Z]){2}_([a-zA-Z0-9])+$')
Make sure valid BBMRI IDs are provided
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*OrganizationA grouping of people or organizations with a common purpose
... 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... description S1..1stringExtension
URL: https://fhir.bbmri.de/StructureDefinition/OrganizationDescription
... bioresourceReference 0..1stringBioresource reference
URL: https://fhir.bbmri.de/StructureDefinition/BioresourceReference
... juridicalPerson S1..1stringExtension
URL: https://fhir.bbmri.de/StructureDefinition/JuridicalPerson
... itSupport 0..1(Complex)IT Support
URL: https://fhir.bbmri.de/StructureDefinition/ITSupport
... partnerCharterSigned 0..1booleanPartner charter signed
URL: https://fhir.bbmri.de/StructureDefinition/PartnerCharterSigned
... collaboration 0..1(Complex)Collaboration
URL: https://fhir.bbmri.de/StructureDefinition/Collaboration
... capabilities 0..*CodeableConceptExtension
URL: https://fhir.bbmri.de/StructureDefinition/Capabilities
Binding: Biobank Capabilities (required)
... qualityStandard S0..*CodeableConceptExtension
URL: https://fhir.bbmri.de/StructureDefinition/QualityStandard
Binding: Quality Standard (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier ΣC1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:Bbmri-EricId SΣC1..1IdentifierIdentifies this organization across multiple systems
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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 SΣ0..1uriThe namespace for the identifier value
Fixed Value: http://www.bbmri-eric.eu/
..... value SΣC0..1stringThe value that is unique
bbmri-id-1: bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present).
Example General: 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 ?!Σ0..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣC1..1stringName used for the organization
... alias S0..1stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom C0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:url SC0..*ContactPointA contact detail for the organization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: url
..... value Σ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address C1..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation 0..*(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet 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
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
.... country SΣ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... Slices for contact 2..*BackboneElementContact for the organization for a certain purpose
Slice: Unordered, Open by value:purpose.coding.code
.... contact:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

..... 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
.... contact:head S1..1BackboneElementContact for the organization for a certain purpose
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... headRole 0..1stringHead role
URL: https://fhir.bbmri.de/StructureDefinition/ContactRole
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose S1..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/contactentity-type
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: ADMIN
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... name 1..1HumanNameA name associated with the contact
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

...... text Σ0..1stringText representation of the full name
...... family SΣ1..1stringFamily name (often called 'Surname')
...... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
...... period Σ0..1PeriodTime period when name was/is in use
..... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
..... address 0..1AddressVisiting or postal addresses for the contact
.... contact:contact 1..1BackboneElementContact for the organization for a certain purpose
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose S1..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
Fixed Value: https://fhir.bbmri.de/CodeSystem/ContactType
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: RESEARCH
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... name 0..1HumanNameA name associated with the contact
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

...... text Σ0..1stringText representation of the full name
...... family SΣ0..1stringFamily name (often called 'Surname')
...... given SΣ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
...... period Σ0..1PeriodTime period when name was/is in use
..... Slices for telecom 1..*ContactPointContact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
...... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
....... value SΣ0..1stringThe actual contact point details
....... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

....... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
....... period Σ0..1PeriodTime period when the contact point was/is in use
...... telecom:email 1..1ContactPointContact details (telephone, email, etc.) for a contact
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
....... value SΣ1..1stringThe actual contact point details
....... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

....... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
....... period Σ0..1PeriodTime period when the contact point was/is in use
..... address 1..1AddressVisiting or postal addresses for the contact
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
...... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
...... 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
Example General: 137 Nowhere Street
...... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
...... district Σ0..1stringDistrict name (aka county)
Example General: Madison
...... state Σ0..1stringSub-unit of country (abbreviations ok)
...... postalCode SΣ0..1stringPostal code for area
Example General: 9132
...... country SΣ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
...... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:Bbmri-EricId.userequiredIdentifierUse
Organization.identifier:Bbmri-EricId.typeextensibleIdentifier Type Codes
Organization.typeexampleOrganizationType
Organization.telecom:url.systemrequiredFixed Value: url
Organization.telecom:url.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.contact.purposeextensibleContactEntityType
Organization.contact:head.purposeextensibleContactEntityType
Organization.contact:head.name.userequiredNameUse
Organization.contact:contact.purposeextensibleContactEntityType
Organization.contact:contact.name.userequiredNameUse
Organization.contact:contact.telecom:phone.systemrequiredFixed Value: phone
Organization.contact:contact.telecom:phone.userequiredContactPointUse
Organization.contact:contact.telecom:email.systemrequiredFixed Value: email
Organization.contact:contact.telecom:email.userequiredContactPointUse
Organization.contact:contact.address.userequiredAddressUse
Organization.contact:contact.address.typerequiredAddressType

Constraints

IdGradePath(s)DetailsRequirements
bbmri-id-1warningOrganization.identifier:Bbmri-EricId.valuebbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present).
: matches('^bbmri-eric:ID:([A-Z]){2}_([a-zA-Z0-9])+$')
Make sure valid BBMRI IDs are provided

This structure is derived from Organization

Summary

Mandatory: 19 elements (2 nested mandatory elements)
Must-Support: 30 elements
Fixed Value: 8 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Organization.identifier is sliced based on the value of value:system
  • The element Organization.telecom is sliced based on the value of value:system
  • The element Organization.contact is sliced based on the value of value:purpose.coding.code
  • The element Organization.contact.telecom is sliced based on the value of value:system

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*OrganizationA grouping of people or organizations with a common purpose
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... description S1..1stringExtension
URL: https://fhir.bbmri.de/StructureDefinition/OrganizationDescription
... bioresourceReference 0..1stringBioresource reference
URL: https://fhir.bbmri.de/StructureDefinition/BioresourceReference
... itSupport 0..1(Complex)IT Support
URL: https://fhir.bbmri.de/StructureDefinition/ITSupport
... partnerCharterSigned 0..1booleanPartner charter signed
URL: https://fhir.bbmri.de/StructureDefinition/PartnerCharterSigned
... collaboration 0..1(Complex)Collaboration
URL: https://fhir.bbmri.de/StructureDefinition/Collaboration
... capabilities 0..*CodeableConceptExtension
URL: https://fhir.bbmri.de/StructureDefinition/Capabilities
Binding: Biobank Capabilities (required)
... qualityStandard S0..*CodeableConceptExtension
URL: https://fhir.bbmri.de/StructureDefinition/QualityStandard
Binding: Quality Standard (required)
... Slices for identifier 1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:Bbmri-EricId S1..1IdentifierIdentifies this organization across multiple systems
..... system S0..1uriThe namespace for the identifier value
Fixed Value: http://www.bbmri-eric.eu/
..... value SC0..1stringThe value that is unique
bbmri-id-1: bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present).
... name S1..1stringName used for the organization
... alias S0..1stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom 0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:url S0..*ContactPointA contact detail for the organization
..... system 1..1codephone | fax | email | pager | url | sms | other
Fixed Value: url
..... value 1..1stringThe actual contact point details
... address 1..*AddressAn address for the organization
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation 0..*(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... country S1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... Slices for contact 2..*BackboneElementContact for the organization for a certain purpose
Slice: Unordered, Open by value:purpose.coding.code
.... contact:head S1..1BackboneElementContact for the organization for a certain purpose
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... headRole 0..1stringHead role
URL: https://fhir.bbmri.de/StructureDefinition/ContactRole
..... purpose S1..1CodeableConceptThe type of contact
...... coding
....... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/contactentity-type
....... code 0..1codeSymbol in syntax defined by the system
Fixed Value: ADMIN
..... name 1..1HumanNameA name associated with the contact
...... family S1..1stringFamily name (often called 'Surname')
...... given S1..*stringGiven names (not always 'first'). Includes middle names
...... prefix S0..*stringParts that come before the name
...... suffix S0..*stringParts that come after the name
.... contact:contact 1..1BackboneElementContact for the organization for a certain purpose
..... purpose S1..1CodeableConceptThe type of contact
...... coding 0..*CodingCode defined by a terminology system
....... system 0..1uriIdentity of the terminology system
Fixed Value: https://fhir.bbmri.de/CodeSystem/ContactType
....... code 0..1codeSymbol in syntax defined by the system
Fixed Value: RESEARCH
..... name
...... family S0..1stringFamily name (often called 'Surname')
...... given S0..*stringGiven names (not always 'first'). Includes middle names
...... prefix S0..*stringParts that come before the name
...... suffix S0..*stringParts that come after the name
..... Slices for telecom 1..*ContactPointContact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
...... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
....... system S0..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
....... value S0..1stringThe actual contact point details
...... telecom:email 1..1ContactPointContact details (telephone, email, etc.) for a contact
....... system S0..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
....... value S1..1stringThe actual contact point details
..... address 1..1AddressVisiting or postal addresses for the contact
...... line S0..*stringStreet name, number, direction & P.O. Box etc.
...... city S0..1stringName of city, town etc.
...... postalCode S0..1stringPostal code for area
...... country S1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
bbmri-id-1warningOrganization.identifier:Bbmri-EricId.valuebbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present).
: matches('^bbmri-eric:ID:([A-Z]){2}_([a-zA-Z0-9])+$')
Make sure valid BBMRI IDs are provided

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*OrganizationA grouping of people or organizations with a common purpose
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... description S1..1stringExtension
URL: https://fhir.bbmri.de/StructureDefinition/OrganizationDescription
... juridicalPerson S1..1stringExtension
URL: https://fhir.bbmri.de/StructureDefinition/JuridicalPerson
... itSupport 0..1(Complex)IT Support
URL: https://fhir.bbmri.de/StructureDefinition/ITSupport
... partnerCharterSigned 0..1booleanPartner charter signed
URL: https://fhir.bbmri.de/StructureDefinition/PartnerCharterSigned
... collaboration 0..1(Complex)Collaboration
URL: https://fhir.bbmri.de/StructureDefinition/Collaboration
... capabilities 0..*CodeableConceptExtension
URL: https://fhir.bbmri.de/StructureDefinition/Capabilities
Binding: Biobank Capabilities (required)
... qualityStandard S0..*CodeableConceptExtension
URL: https://fhir.bbmri.de/StructureDefinition/QualityStandard
Binding: Quality Standard (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier ΣC1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:Bbmri-EricId SΣC1..1IdentifierIdentifies this organization across multiple systems
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ0..1uriThe namespace for the identifier value
Fixed Value: http://www.bbmri-eric.eu/
..... value SΣC0..1stringThe value that is unique
bbmri-id-1: bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present).
Example General: 123456
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... name SΣC1..1stringName used for the organization
... alias S0..1stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom C0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:url SC0..*ContactPointA contact detail for the organization
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: url
..... value Σ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... address C1..*AddressAn address for the organization
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation 0..*(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... country SΣ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... Slices for contact 2..*BackboneElementContact for the organization for a certain purpose
Slice: Unordered, Open by value:purpose.coding.code
.... contact:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... contact:head S1..1BackboneElementContact for the organization for a certain purpose
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... headRole 0..1stringHead role
URL: https://fhir.bbmri.de/StructureDefinition/ContactRole
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose S1..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

..... name 1..1HumanNameA name associated with the contact
...... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

...... family SΣ1..1stringFamily name (often called 'Surname')
...... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... contact:contact 1..1BackboneElementContact for the organization for a certain purpose
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose S1..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

...... coding Σ0..*CodingCode defined by a terminology system
....... system Σ0..1uriIdentity of the terminology system
Fixed Value: https://fhir.bbmri.de/CodeSystem/ContactType
....... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: RESEARCH
..... name 0..1HumanNameA name associated with the contact
...... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

...... family SΣ0..1stringFamily name (often called 'Surname')
...... given SΣ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... Slices for telecom 1..*ContactPointContact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
...... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
....... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
....... value SΣ0..1stringThe actual contact point details
....... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... telecom:email 1..1ContactPointContact details (telephone, email, etc.) for a contact
....... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
....... value SΣ1..1stringThe actual contact point details
....... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... address 1..1AddressVisiting or postal addresses for the contact
...... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
...... 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
Example General: 137 Nowhere Street
...... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
...... postalCode SΣ0..1stringPostal code for area
Example General: 9132
...... country SΣ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.identifier:Bbmri-EricId.userequiredIdentifierUse
Organization.telecom:url.systemrequiredFixed Value: url
Organization.telecom:url.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.contact:head.purposeextensibleContactEntityType
Organization.contact:head.name.userequiredNameUse
Organization.contact:contact.purposeextensibleContactEntityType
Organization.contact:contact.name.userequiredNameUse
Organization.contact:contact.telecom:phone.systemrequiredFixed Value: phone
Organization.contact:contact.telecom:phone.userequiredContactPointUse
Organization.contact:contact.telecom:email.systemrequiredFixed Value: email
Organization.contact:contact.telecom:email.userequiredContactPointUse
Organization.contact:contact.address.userequiredAddressUse

Constraints

IdGradePath(s)DetailsRequirements
bbmri-id-1warningOrganization.identifier:Bbmri-EricId.valuebbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present).
: matches('^bbmri-eric:ID:([A-Z]){2}_([a-zA-Z0-9])+$')
Make sure valid BBMRI IDs are provided

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*OrganizationA grouping of people or organizations with a common purpose
... 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... description S1..1stringExtension
URL: https://fhir.bbmri.de/StructureDefinition/OrganizationDescription
... bioresourceReference 0..1stringBioresource reference
URL: https://fhir.bbmri.de/StructureDefinition/BioresourceReference
... juridicalPerson S1..1stringExtension
URL: https://fhir.bbmri.de/StructureDefinition/JuridicalPerson
... itSupport 0..1(Complex)IT Support
URL: https://fhir.bbmri.de/StructureDefinition/ITSupport
... partnerCharterSigned 0..1booleanPartner charter signed
URL: https://fhir.bbmri.de/StructureDefinition/PartnerCharterSigned
... collaboration 0..1(Complex)Collaboration
URL: https://fhir.bbmri.de/StructureDefinition/Collaboration
... capabilities 0..*CodeableConceptExtension
URL: https://fhir.bbmri.de/StructureDefinition/Capabilities
Binding: Biobank Capabilities (required)
... qualityStandard S0..*CodeableConceptExtension
URL: https://fhir.bbmri.de/StructureDefinition/QualityStandard
Binding: Quality Standard (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier ΣC1..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:Bbmri-EricId SΣC1..1IdentifierIdentifies this organization across multiple systems
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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 SΣ0..1uriThe namespace for the identifier value
Fixed Value: http://www.bbmri-eric.eu/
..... value SΣC0..1stringThe value that is unique
bbmri-id-1: bbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present).
Example General: 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 ?!Σ0..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization.


... name SΣC1..1stringName used for the organization
... alias S0..1stringA list of alternate names that the organization is known as, or was known as in the past
... Slices for telecom C0..*ContactPointA contact detail for the organization
Slice: Unordered, Open by value:system
.... telecom:url SC0..*ContactPointA contact detail for the organization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: url
..... value Σ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address C1..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation 0..*(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet 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
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
.... country SΣ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... Slices for contact 2..*BackboneElementContact for the organization for a certain purpose
Slice: Unordered, Open by value:purpose.coding.code
.... contact:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

..... 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
.... contact:head S1..1BackboneElementContact for the organization for a certain purpose
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... headRole 0..1stringHead role
URL: https://fhir.bbmri.de/StructureDefinition/ContactRole
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose S1..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/contactentity-type
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: ADMIN
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... name 1..1HumanNameA name associated with the contact
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

...... text Σ0..1stringText representation of the full name
...... family SΣ1..1stringFamily name (often called 'Surname')
...... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
...... period Σ0..1PeriodTime period when name was/is in use
..... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
..... address 0..1AddressVisiting or postal addresses for the contact
.... contact:contact 1..1BackboneElementContact for the organization for a certain purpose
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... purpose S1..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
Fixed Value: https://fhir.bbmri.de/CodeSystem/ContactType
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: RESEARCH
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... name 0..1HumanNameA name associated with the contact
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

...... text Σ0..1stringText representation of the full name
...... family SΣ0..1stringFamily name (often called 'Surname')
...... given SΣ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
...... prefix SΣ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
...... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
...... period Σ0..1PeriodTime period when name was/is in use
..... Slices for telecom 1..*ContactPointContact details (telephone, email, etc.) for a contact
Slice: Unordered, Open by value:system
...... telecom:phone S0..*ContactPointContact details (telephone, email, etc.) for a contact
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
....... value SΣ0..1stringThe actual contact point details
....... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

....... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
....... period Σ0..1PeriodTime period when the contact point was/is in use
...... telecom:email 1..1ContactPointContact details (telephone, email, etc.) for a contact
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
....... value SΣ1..1stringThe actual contact point details
....... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

....... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
....... period Σ0..1PeriodTime period when the contact point was/is in use
..... address 1..1AddressVisiting or postal addresses for the contact
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
...... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
...... 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
Example General: 137 Nowhere Street
...... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
...... district Σ0..1stringDistrict name (aka county)
Example General: Madison
...... state Σ0..1stringSub-unit of country (abbreviations ok)
...... postalCode SΣ0..1stringPostal code for area
Example General: 9132
...... country SΣ1..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
...... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:Bbmri-EricId.userequiredIdentifierUse
Organization.identifier:Bbmri-EricId.typeextensibleIdentifier Type Codes
Organization.typeexampleOrganizationType
Organization.telecom:url.systemrequiredFixed Value: url
Organization.telecom:url.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.contact.purposeextensibleContactEntityType
Organization.contact:head.purposeextensibleContactEntityType
Organization.contact:head.name.userequiredNameUse
Organization.contact:contact.purposeextensibleContactEntityType
Organization.contact:contact.name.userequiredNameUse
Organization.contact:contact.telecom:phone.systemrequiredFixed Value: phone
Organization.contact:contact.telecom:phone.userequiredContactPointUse
Organization.contact:contact.telecom:email.systemrequiredFixed Value: email
Organization.contact:contact.telecom:email.userequiredContactPointUse
Organization.contact:contact.address.userequiredAddressUse
Organization.contact:contact.address.typerequiredAddressType

Constraints

IdGradePath(s)DetailsRequirements
bbmri-id-1warningOrganization.identifier:Bbmri-EricId.valuebbmri-eric:ID:<CC>_<local id>: SHALL contain the bbmri-eric prefix followed by valid ISO-3166-1 alpha 2 country code followed by _ followed by biobank ID of national registry (if present).
: matches('^bbmri-eric:ID:([A-Z]){2}_([a-zA-Z0-9])+$')
Make sure valid BBMRI IDs are provided

This structure is derived from Organization

Summary

Mandatory: 19 elements (2 nested mandatory elements)
Must-Support: 30 elements
Fixed Value: 8 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Organization.identifier is sliced based on the value of value:system
  • The element Organization.telecom is sliced based on the value of value:system
  • The element Organization.contact is sliced based on the value of value:purpose.coding.code
  • The element Organization.contact.telecom is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron