HL7 Europe Imaging Study Report
0.1.0-ballot - ci-build 150

HL7 Europe Imaging Study Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/oijauregui/ehdsimaging/tree/master and changes regularly. See the Directory of published versions

Resource Profile: Report obligations for ImPatient

Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/Report-ImPatient Version: 0.1.0-ballot
Draft as of 2025-07-02 Computable Name: Report_ImPatient

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

Report obligations for ImPatient

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* ImPatient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 AddressEu Value of extension
.... extension:sex-for-clinical-use O 0..* (Complex) A context-specific sex parameter for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
ObligationsActor
SHALL:populate-if-known Imaging study report provider
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "value"
....... value[x] O 1..1 CodeableConcept Value of extension
Binding: Sex Parameter for Clinical Use (required)
ObligationsActor
SHALL:populate-if-known Imaging study report provider
...... extension:period 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "period"
....... value[x] O 1..1 Period Value of extension
ObligationsActor
SHALL:populate-if-known Imaging study report provider
...... extension:comment 0..1 Extension Comments about the sex parameter for clinical use
....... extension 0..0
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:supportingInfo 0..* Extension Source of the sex for clincal use
....... extension 0..0
....... url 1..1 uri "supportingInfo"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Resource)
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse"
.... extension:patient-citizenship O 0..* (Complex) Nation(s) where the patient claims citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... extension:patient-nationality O 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... identifier OΣ 0..* Identifier Patient identifiers
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... active ?!OΣ 0..1 boolean Whether this patient's record is in active use
ObligationsActor
SHALL:handle Imaging study report provider
... name OΣ 0..* HumanName A name associated with the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... Slices for extension Content/Rules for all slices
..... extension:name-absent-reason 0..* code Reason for not providing the name.
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
... telecom OΣ 0..* ContactPoint A contact detail for the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... gender OΣ 0..1 code Administrative Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... birthDate OΣ 0..1 date The date of birth for the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... Slices for extension Content/Rules for all slices
..... extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address OΣ 0..* AddressEu An address for the individual
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... maritalStatus O 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.extension:sex-for-clinical-use.extension:value.value[x]requiredSexParameterForClinicalUse
http://terminology.hl7.org/ValueSet/sex-parameter-for-clinical-use
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
From the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
From the FHIR Standard
Patient.maritalStatusextensibleMaritalStatusCodes
http://hl7.org/fhir/ValueSet/marital-status
From the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA 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()

This structure is derived from ImPatient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* ImPatient Information about an individual or animal receiving health care services
... Slices for extension Content/Rules for all slices
.... extension:sex-for-clinical-use O 0..* PatSexParameterForClinicalUse A context-specific sex parameter for clinical use
ObligationsActor
SHALL:populate-if-known Imaging study report provider
..... Slices for extension Content/Rules for all slices
...... extension:value 1..1 Extension Extension
....... value[x] O 1..1 CodeableConcept Value of extension
ObligationsActor
SHALL:populate-if-known Imaging study report provider
...... extension:period 0..1 Extension Extension
....... value[x] O 1..1 Period Value of extension
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... extension:patient-citizenship O 0..* PatCitizenship Nation(s) where the patient claims citizenship
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... extension:patient-nationality O 0..* PatNationality Nationality
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... identifier O 0..* Identifier Patient identifiers
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... active O 0..1 boolean Whether this patient's record is in active use
ObligationsActor
SHALL:handle Imaging study report provider
... telecom O 0..* ContactPoint A contact detail for the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... gender O 0..1 code Administrative Gender
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... birthDate O 0..1 date The date of birth for the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... address O 0..* AddressEu An address for the individual
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... maritalStatus O 0..1 CodeableConcept Marital (civil) status of a patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... communication
.... language O 1..1 CodeableConcept Communication language
ObligationsActor
SHALL:populate-if-known Imaging study report provider

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* ImPatient Information about an individual or animal receiving health care services
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 AddressEu Value of extension
.... extension:sex-for-clinical-use O 0..* (Complex) A context-specific sex parameter for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
ObligationsActor
SHALL:populate-if-known Imaging study report provider
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "value"
....... value[x] O 1..1 CodeableConcept Value of extension
Binding: Sex Parameter for Clinical Use (required)
ObligationsActor
SHALL:populate-if-known Imaging study report provider
...... extension:period 0..1 Extension Extension
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "period"
....... value[x] O 1..1 Period Value of extension
ObligationsActor
SHALL:populate-if-known Imaging study report provider
...... extension:comment 0..1 Extension Comments about the sex parameter for clinical use
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:supportingInfo 0..* Extension Source of the sex for clincal use
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "supportingInfo"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Resource)
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse"
.... extension:patient-citizenship O 0..* (Complex) Nation(s) where the patient claims citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... extension:patient-nationality O 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier OΣ 0..* Identifier Patient identifiers
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... active ?!OΣ 0..1 boolean Whether this patient's record is in active use
ObligationsActor
SHALL:handle Imaging study report provider
... name OΣ 0..* HumanName A name associated with the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:name-absent-reason 0..* code Reason for not providing the name.
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name.
.... family Σ 0..1 string Family name.
Example spanish: Valero Iglesias
.... given Σ 0..* string Given names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom OΣ 0..* ContactPoint A contact detail for the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... gender OΣ 0..1 code Administrative Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... birthDate OΣ 0..1 date The date of birth for the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1 date Primitive value for date
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address OΣ 0..* AddressEu An address for the individual
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... maritalStatus O 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... 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
.... relationship 0..* CodeableConcept Contact relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name C 0..1 HumanName Contact name
.... telecom C 0..* ContactPoint Contact details for the person
.... address C 0..1 AddressEu Contact person address
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... 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
.... language O 1..1 CodeableConcept Communication language
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization (EU base) | PractitionerRole (EU base) | Practitioner (EU base)) Patient's nominated primary care provider.
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
.... 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
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Patient.extension:sex-for-clinical-use.extension:value.value[x]requiredSexParameterForClinicalUse
http://terminology.hl7.org/ValueSet/sex-parameter-for-clinical-use
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
From the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
From the FHIR Standard
Patient.maritalStatusextensibleMaritalStatusCodes
http://hl7.org/fhir/ValueSet/marital-status
From the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
From the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
From the FHIR Standard
Patient.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA 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()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from ImPatient

Summary

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* ImPatient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 AddressEu Value of extension
.... extension:sex-for-clinical-use O 0..* (Complex) A context-specific sex parameter for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
ObligationsActor
SHALL:populate-if-known Imaging study report provider
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "value"
....... value[x] O 1..1 CodeableConcept Value of extension
Binding: Sex Parameter for Clinical Use (required)
ObligationsActor
SHALL:populate-if-known Imaging study report provider
...... extension:period 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "period"
....... value[x] O 1..1 Period Value of extension
ObligationsActor
SHALL:populate-if-known Imaging study report provider
...... extension:comment 0..1 Extension Comments about the sex parameter for clinical use
....... extension 0..0
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:supportingInfo 0..* Extension Source of the sex for clincal use
....... extension 0..0
....... url 1..1 uri "supportingInfo"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Resource)
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse"
.... extension:patient-citizenship O 0..* (Complex) Nation(s) where the patient claims citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... extension:patient-nationality O 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... identifier OΣ 0..* Identifier Patient identifiers
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... active ?!OΣ 0..1 boolean Whether this patient's record is in active use
ObligationsActor
SHALL:handle Imaging study report provider
... name OΣ 0..* HumanName A name associated with the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... Slices for extension Content/Rules for all slices
..... extension:name-absent-reason 0..* code Reason for not providing the name.
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
... telecom OΣ 0..* ContactPoint A contact detail for the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... gender OΣ 0..1 code Administrative Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... birthDate OΣ 0..1 date The date of birth for the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... Slices for extension Content/Rules for all slices
..... extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address OΣ 0..* AddressEu An address for the individual
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... maritalStatus O 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.extension:sex-for-clinical-use.extension:value.value[x]requiredSexParameterForClinicalUse
http://terminology.hl7.org/ValueSet/sex-parameter-for-clinical-use
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
From the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
From the FHIR Standard
Patient.maritalStatusextensibleMaritalStatusCodes
http://hl7.org/fhir/ValueSet/marital-status
From the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA 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()

Differential View

This structure is derived from ImPatient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* ImPatient Information about an individual or animal receiving health care services
... Slices for extension Content/Rules for all slices
.... extension:sex-for-clinical-use O 0..* PatSexParameterForClinicalUse A context-specific sex parameter for clinical use
ObligationsActor
SHALL:populate-if-known Imaging study report provider
..... Slices for extension Content/Rules for all slices
...... extension:value 1..1 Extension Extension
....... value[x] O 1..1 CodeableConcept Value of extension
ObligationsActor
SHALL:populate-if-known Imaging study report provider
...... extension:period 0..1 Extension Extension
....... value[x] O 1..1 Period Value of extension
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... extension:patient-citizenship O 0..* PatCitizenship Nation(s) where the patient claims citizenship
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... extension:patient-nationality O 0..* PatNationality Nationality
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... identifier O 0..* Identifier Patient identifiers
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... active O 0..1 boolean Whether this patient's record is in active use
ObligationsActor
SHALL:handle Imaging study report provider
... telecom O 0..* ContactPoint A contact detail for the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... gender O 0..1 code Administrative Gender
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... birthDate O 0..1 date The date of birth for the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... address O 0..* AddressEu An address for the individual
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... maritalStatus O 0..1 CodeableConcept Marital (civil) status of a patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... communication
.... language O 1..1 CodeableConcept Communication language
ObligationsActor
SHALL:populate-if-known Imaging study report provider

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* ImPatient Information about an individual or animal receiving health care services
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 AddressEu Value of extension
.... extension:sex-for-clinical-use O 0..* (Complex) A context-specific sex parameter for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
ObligationsActor
SHALL:populate-if-known Imaging study report provider
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension Extension
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "value"
....... value[x] O 1..1 CodeableConcept Value of extension
Binding: Sex Parameter for Clinical Use (required)
ObligationsActor
SHALL:populate-if-known Imaging study report provider
...... extension:period 0..1 Extension Extension
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "period"
....... value[x] O 1..1 Period Value of extension
ObligationsActor
SHALL:populate-if-known Imaging study report provider
...... extension:comment 0..1 Extension Comments about the sex parameter for clinical use
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:supportingInfo 0..* Extension Source of the sex for clincal use
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "supportingInfo"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(Resource)
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse"
.... extension:patient-citizenship O 0..* (Complex) Nation(s) where the patient claims citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... extension:patient-nationality O 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier OΣ 0..* Identifier Patient identifiers
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... active ?!OΣ 0..1 boolean Whether this patient's record is in active use
ObligationsActor
SHALL:handle Imaging study report provider
... name OΣ 0..* HumanName A name associated with the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:name-absent-reason 0..* code Reason for not providing the name.
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name.
.... family Σ 0..1 string Family name.
Example spanish: Valero Iglesias
.... given Σ 0..* string Given names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom OΣ 0..* ContactPoint A contact detail for the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... gender OΣ 0..1 code Administrative Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... birthDate OΣ 0..1 date The date of birth for the patient
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1 date Primitive value for date
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address OΣ 0..* AddressEu An address for the individual
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... maritalStatus O 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
ObligationsActor
SHALL:populate-if-known Imaging study report provider
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... 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
.... relationship 0..* CodeableConcept Contact relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name C 0..1 HumanName Contact name
.... telecom C 0..* ContactPoint Contact details for the person
.... address C 0..1 AddressEu Contact person address
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... 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
.... language O 1..1 CodeableConcept Communication language
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
ObligationsActor
SHALL:populate-if-known Imaging study report provider
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization (EU base) | PractitionerRole (EU base) | Practitioner (EU base)) Patient's nominated primary care provider.
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
.... 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
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Patient.extension:sex-for-clinical-use.extension:value.value[x]requiredSexParameterForClinicalUse
http://terminology.hl7.org/ValueSet/sex-parameter-for-clinical-use
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
From the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
From the FHIR Standard
Patient.maritalStatusextensibleMaritalStatusCodes
http://hl7.org/fhir/ValueSet/marital-status
From the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
From the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
From the FHIR Standard
Patient.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA 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()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from ImPatient

Summary

 

Other representations of profile: CSV, Excel, Schematron